org.tango.server.events

Enum EventType

java.lang.Object

java.lang.Enum<EventType>

org.tango.server.events.EventType

All Implemented Interfaces:

Serializable, Comparable<EventType>

public enum EventType
extends Enum<EventType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVE_EVENT Archived event.
ATT_CONF_EVENT Attribute configuration event.
CHANGE_EVENT Change event.
DATA_READY_EVENT Data ready event.
INTERFACE_CHANGE_EVENT Interface change event.
PERIODIC_EVENT Periodic event.
PIPE_EVENT Interface change event.
USER_EVENT User event.

Method Summary

Modifier and Type	Method and Description
static EventType	getEvent(int eventValue) Get an EventType from a String
static EventType	getEvent(String string) Get an EventType from a String
String	getString()
int	getValue()
static EventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EventType[]	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

CHANGE_EVENT

public static final EventType CHANGE_EVENT

Change event. Use the attribute properties abs_change and/or rel_change

PERIODIC_EVENT

public static final EventType PERIODIC_EVENT

Periodic event. Send an event at the period specified by the attribute property event_period

ARCHIVE_EVENT

public static final EventType ARCHIVE_EVENT

Archived event. Send a periodic event at period configured in property archive_period. Or/and change event with values from archive_rel_change and/or archive_abs_change

USER_EVENT

public static final EventType USER_EVENT

User event.

ATT_CONF_EVENT

public static final EventType ATT_CONF_EVENT

Attribute configuration event. Send an event if an attribute's properties change.

DATA_READY_EVENT

public static final EventType DATA_READY_EVENT

Data ready event.

INTERFACE_CHANGE_EVENT

public static final EventType INTERFACE_CHANGE_EVENT

Interface change event.

PIPE_EVENT

public static final EventType PIPE_EVENT

Interface change event.

Method Detail

values

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

Returns:

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

valueOf

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

getEvent

public static EventType getEvent(String string)
                          throws fr.esrf.Tango.DevFailed

Get an EventType from a String

Parameters:

string - the event type as a String

Returns:

the EventType

Throws:

fr.esrf.Tango.DevFailed - if event type does not exist

getEvent

public static EventType getEvent(int eventValue)
                          throws fr.esrf.Tango.DevFailed

Get an EventType from a String

Parameters:

eventValue - the event type as an int

Returns:

the EventType

Throws:

fr.esrf.Tango.DevFailed - if event type does not exist

getString

public String getString()

Returns:

EventType as a String

getValue

public int getValue()

Returns:

EventType as an int