Package org.vaadin.spring.events

Enum Class EventScope

java.lang.Object

java.lang.Enum<EventScope>

org.vaadin.spring.events.EventScope

All Implemented Interfaces:

Serializable, Comparable<EventScope>, Constable

public enum EventScope
extends Enum<EventScope>

Enumeration of event scopes.

Author:

Petter Holmström (petter@vaadin.com)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION	The event is application wide.
SESSION	The event is specific to the current (Vaadin) session.
UI	The event is specific to the current UI.
UNDEFINED	Undefined event scope.
VIEW	The event is specific to the current view.

Method Summary

Modifier and Type	Method	Description
static EventScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

APPLICATION

public static final EventScope APPLICATION

The event is application wide.

SESSION

public static final EventScope SESSION

The event is specific to the current (Vaadin) session.

UI

public static final EventScope UI

The event is specific to the current UI.

VIEW

public static final EventScope VIEW

The event is specific to the current view.

UNDEFINED

public static final EventScope UNDEFINED

Undefined event scope. An internal event scope used only when no scope has been explicitly defined.

See Also:

• EventBusListenerMethod.scope()

Method Details

values

public static EventScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EventScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null