org.eclipse.ditto.services.gateway.streaming

Enum StreamingType

java.lang.Object

java.lang.Enum<StreamingType>

org.eclipse.ditto.services.gateway.streaming.StreamingType

All Implemented Interfaces:

Serializable, Comparable<StreamingType>

public enum StreamingType
extends Enum<StreamingType>

Enumeration of the different types which can be streamed in the Gateway (e.g. to an open Websocket connection). Each type is also aware of the key used for distributed pub/sub in the Akka cluster.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENTS
LIVE_COMMANDS
LIVE_EVENTS
MESSAGES

Method Summary

Modifier and Type	Method and Description
static StreamingType	fromTopic(String distributedPubSubTopic) Returns a StreamingType from a given distributedPubSubTopic representation.
String	getDistributedPubSubTopic()
static StreamingType	valueOf(String name) Returns the enum constant of this type with the specified name.
static StreamingType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVENTS

public static final StreamingType EVENTS

MESSAGES

public static final StreamingType MESSAGES

LIVE_COMMANDS

public static final StreamingType LIVE_COMMANDS

LIVE_EVENTS

public static final StreamingType LIVE_EVENTS

Method Detail

values

public static StreamingType[] 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 (StreamingType c : StreamingType.values())
    System.out.println(c);

Returns:

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

valueOf

public static StreamingType 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

getDistributedPubSubTopic

public String getDistributedPubSubTopic()

Returns:

the key used for distributed pub/sub in the Akka cluster for this StreamingType.

fromTopic

public static StreamingType fromTopic(String distributedPubSubTopic)

Returns a StreamingType from a given distributedPubSubTopic representation.

Parameters:

distributedPubSubTopic - the string representation of the topic.

Returns:

the StreamingType.