org.eclipse.ditto.protocoladapter

Enum TopicPath.Channel

java.lang.Object

java.lang.Enum<TopicPath.Channel>

org.eclipse.ditto.protocoladapter.TopicPath.Channel

All Implemented Interfaces:

Serializable, Comparable<TopicPath.Channel>

Enclosing interface:

TopicPath

public static enum TopicPath.Channel
extends Enum<TopicPath.Channel>

An enumeration of topic path channel.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LIVE
TWIN

Method Summary

Modifier and Type	Method and Description
static Optional<TopicPath.Channel>	forName(String name) Creates a Channel from the passed Channel name if such an enum value exists, otherwise an empty Optional.
String	getName() Returns the Channel name as String.
String	toString()
static TopicPath.Channel	valueOf(String name) Returns the enum constant of this type with the specified name.
static TopicPath.Channel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TWIN

public static final TopicPath.Channel TWIN

LIVE

public static final TopicPath.Channel LIVE

Method Detail

values

public static TopicPath.Channel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TopicPath.Channel c : TopicPath.Channel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TopicPath.Channel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forName

public static Optional<TopicPath.Channel> forName(String name)

Creates a Channel from the passed Channel name if such an enum value exists, otherwise an empty Optional.

Parameters:

name - the Channel name to create the Channel enum value of.

Returns:

the optional Channel.

getName

public String getName()

Returns the Channel name as String.

Returns:

the Channel name as String.

toString

public String toString()

Overrides:

toString in class Enum<TopicPath.Channel>