public static enum UnlistenEventListener.Scope extends Enum<UnlistenEventListener.Scope> implements Serializable
UnlistenEvent
instances.
See the various scopes (LOCAL
,
TIMEOUT
and
UNLISTEN
) for the according description.Enum Constant and Description |
---|
LOCAL
An
UnlistenEventListener registered with the local scope
does only recognize local unlisten events for example caused by local timeouts or a lost connection to the server side. |
TIMEOUT
An
UnlistenEventListener registered with the timeout scope
does recognize local unlisten events (for example caused by local timeouts or a lost connection to the server side) and
unlisten events of other users / clients caused by a connection timeout of the specified user / client. |
UNLISTEN
An
UnlistenEventListener registered with the unlisten scope
does recognize all unlisten events: Local unlisten events (for example caused by local timeouts or a lost connection to the server side),
unlisten events of other users / clients caused by a timeout and domain unlisten events of other users / clients for
example caused by removing a listener for a domain. |
Modifier and Type | Method and Description |
---|---|
static UnlistenEventListener.Scope |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static UnlistenEventListener.Scope[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final UnlistenEventListener.Scope LOCAL
UnlistenEventListener
registered with the local scope
does only recognize local unlisten events for example caused by local timeouts or a lost connection to the server side.
Therefore it isn't necessary to register it to the server side, but unlisten events of other users / clients
can't be get with the local scope.public static final UnlistenEventListener.Scope TIMEOUT
UnlistenEventListener
registered with the timeout scope
does recognize local unlisten events (for example caused by local timeouts or a lost connection to the server side) and
unlisten events of other users / clients caused by a connection timeout of the specified user / client.public static final UnlistenEventListener.Scope UNLISTEN
UnlistenEventListener
registered with the unlisten scope
does recognize all unlisten events: Local unlisten events (for example caused by local timeouts or a lost connection to the server side),
unlisten events of other users / clients caused by a timeout and domain unlisten events of other users / clients for
example caused by removing a listener for a domain.public static UnlistenEventListener.Scope[] values()
for (UnlistenEventListener.Scope c : UnlistenEventListener.Scope.values()) System.out.println(c);
public static UnlistenEventListener.Scope valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant
with the specified nameNullPointerException
- if the argument is nullCopyright © 2012. All Rights Reserved.