com.neeve.client.link
Enum ClientLinkManagerEvent

java.lang.Object
  java.lang.Enum<ClientLinkManagerEvent>
      com.neeve.client.link.ClientLinkManagerEvent

All Implemented Interfaces:

Serializable, Comparable<ClientLinkManagerEvent>

public enum ClientLinkManagerEvent
extends Enum<ClientLinkManagerEvent>

Class containing client link manager event definitions.

This class contains event type and associated structure definitions for events dispatched by a client link manager.

Nested Class Summary

static class	ClientLinkManagerEvent.LinkOpCompleteEventData Data object indicating the status of the completion of a link related operation.
static class	ClientLinkManagerEvent.LinkOpenCompleteEventData Data object indicating the status of the completion of a link open operation.

Enum Constant Summary

LINK_OPEN_FAIL
Indicates that a link manager has failed to open a link.

LINK_OPEN_SUCCESS
Indicates that a link manager has succesfully opened a link.

LINK_PARSE_FAIL
Indicates that a link manager failed to parse a link descriptor.

LINK_PARSE_SUCCESS
Indicates that a link manager has successfully parsed a link descriptor.

OPEN_BEGIN
Indicates that a link manager has started the open process.

OPEN_END
Indicates that a link manager open process has ended.

Method Summary

static ClientLinkManagerEvent	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientLinkManagerEvent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LINK_PARSE_SUCCESS

public static final ClientLinkManagerEvent LINK_PARSE_SUCCESS

Indicates that a link manager has successfully parsed a link descriptor.

This event is dispatched by a link managr during instantiation after it successfully parses a supplied link descriptor for syntactic correcteness. The event data for this event is an instance of ClientLinkManagerEvent.LinkOpCompleteEventData with the status field set to true and exception field set to null.

Threading:

This event will always be dispatched by the thread that is instantiating the link manager object.

LINK_PARSE_FAIL

public static final ClientLinkManagerEvent LINK_PARSE_FAIL

Indicates that a link manager failed to parse a link descriptor.

This event is dispatched by a link manager during instantiation after it fails to parse a supplied link descriptor for syntactic correctness. The event data for this event is an instance of ClientLinkManagerEvent.LinkOpCompleteEventData with the status field set to false and the exception field set to the reason for the failure.

Threading:

This event will always be dispatched by the thread that is instantiating the link manager object.

OPEN_BEGIN

public static final ClientLinkManagerEvent OPEN_BEGIN

Indicates that a link manager has started the open process.

This event is dispatched by a link manager on the start of the open process. The event data for this event is null.

Threading:

This event will always be dispatched by the link manager reader thread.

LINK_OPEN_SUCCESS

public static final ClientLinkManagerEvent LINK_OPEN_SUCCESS

Indicates that a link manager has succesfully opened a link.

This event is dispatched by a link manager to indicate the successful opening of a link. The event data for this event is an instance of the ClientLinkManagerEvent.LinkOpenCompleteEventData class with the status field set to true and the exception field set to null.

Threading:

This event will always be dispatched by the link manager reader thread.

LINK_OPEN_FAIL

public static final ClientLinkManagerEvent LINK_OPEN_FAIL

Indicates that a link manager has failed to open a link.

This event is dispatched by a link manager to indicate the failure to open a link. The event data for this event is an instance of the ClientLinkManagerEvent.LinkOpenCompleteEventData class with the status field set to false and the exception field set to the cause of the failure.

Threading:

This event will always be dispatched by the link manager reader thread.

OPEN_END

public static final ClientLinkManagerEvent OPEN_END

Indicates that a link manager open process has ended.

This event is dispatched by a link manager at the end of the open process. The event data for this event is null.

Threading:

This event will always be dispatched by the link manager reader thread.

Method Detail

values

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

Returns:

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

valueOf

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