Package com.vaadin.flow.server

Enum VaadinSessionState

java.lang.Object

java.lang.Enum<VaadinSessionState>

com.vaadin.flow.server.VaadinSessionState

All Implemented Interfaces:

Serializable, Comparable<VaadinSessionState>

public enum VaadinSessionState
extends Enum<VaadinSessionState>

The lifecycle state of a VaadinSession.

Since:

1.0

Author:

Vaadin Ltd

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	The session is closed; all the UIs have been removed and SessionDestroyListeners have been called.
CLOSING	The close method has been called; the session will be closed as soon as the current request ends.
OPEN	The session is active and accepting client requests.

Method Summary

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

OPEN

public static final VaadinSessionState OPEN

The session is active and accepting client requests.

CLOSING

public static final VaadinSessionState CLOSING

The close method has been called; the session will be closed as soon as the current request ends.

CLOSED

public static final VaadinSessionState CLOSED

The session is closed; all the UIs have been removed and SessionDestroyListeners have been called.

Method Detail

values

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

Returns:

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

valueOf

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