Package org.opentrafficsim.sim0mq.publisher

Enum SubscriptionHandler.Command

java.lang.Object

java.lang.Enum<SubscriptionHandler.Command>

org.opentrafficsim.sim0mq.publisher.SubscriptionHandler.Command

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SubscriptionHandler.Command>

Enclosing class:

SubscriptionHandler

public static enum SubscriptionHandler.Command
extends java.lang.Enum<SubscriptionHandler.Command>

The commands that a SubscriptionHandler understands.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GET_ADDRESS_META_DATA	Get the address meta data.
GET_COMMANDS	Get the set of implemented commands (must - itself - always be implemented).
GET_CURRENT	Get current set (if a collection), c.q.
GET_LIST	Get the output of the IdSource.
GET_RESULT_META_DATA	Get the result meta data.
SUBSCRIBE_TO_ADD	Subscribe to add events.
SUBSCRIBE_TO_CHANGE	Subscribe to change events.
SUBSCRIBE_TO_REMOVE	Subscribe to remove events.
UNSUBSCRIBE_FROM_ADD	Unsubscribe to add events.
UNSUBSCRIBE_FROM_CHANGE	Unsubscribe to change events.
UNSUBSCRIBE_FROM_REMOVE	Unsubscribe to remove events.

Method Summary

Modifier and Type	Method	Description
static SubscriptionHandler.Command	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SubscriptionHandler.Command[]	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

SUBSCRIBE_TO_ADD

public static final SubscriptionHandler.Command SUBSCRIBE_TO_ADD

Subscribe to add events.

SUBSCRIBE_TO_REMOVE

public static final SubscriptionHandler.Command SUBSCRIBE_TO_REMOVE

Subscribe to remove events.

SUBSCRIBE_TO_CHANGE

public static final SubscriptionHandler.Command SUBSCRIBE_TO_CHANGE

Subscribe to change events.

UNSUBSCRIBE_FROM_ADD

public static final SubscriptionHandler.Command UNSUBSCRIBE_FROM_ADD

Unsubscribe to add events.

UNSUBSCRIBE_FROM_REMOVE

public static final SubscriptionHandler.Command UNSUBSCRIBE_FROM_REMOVE

Unsubscribe to remove events.

UNSUBSCRIBE_FROM_CHANGE

public static final SubscriptionHandler.Command UNSUBSCRIBE_FROM_CHANGE

Unsubscribe to change events.

GET_CURRENT

public static final SubscriptionHandler.Command GET_CURRENT

Get current set (if a collection), c.q. state (if properties of one object).

GET_ADDRESS_META_DATA

public static final SubscriptionHandler.Command GET_ADDRESS_META_DATA

Get the address meta data.

GET_RESULT_META_DATA

public static final SubscriptionHandler.Command GET_RESULT_META_DATA

Get the result meta data.

GET_LIST

public static final SubscriptionHandler.Command GET_LIST

Get the output of the IdSource.

GET_COMMANDS

public static final SubscriptionHandler.Command GET_COMMANDS

Get the set of implemented commands (must - itself - always be implemented).

Method Detail

values

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

Returns:

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

valueOf

public static SubscriptionHandler.Command valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null