Package com.vaadin.flow.shared.ui

Enum Class Transport

java.lang.Object

java.lang.Enum<Transport>

com.vaadin.flow.shared.ui.Transport

All Implemented Interfaces:

Serializable, Comparable<Transport>, Constable

public enum Transport
extends Enum<Transport>

Transport modes for Push

Since:

1.0

Author:

Vaadin Ltd

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
LONG_POLLING	HTTP long polling.
WEBSOCKET	Websocket.
WEBSOCKET_XHR	Websocket for server to client, XHR for client to server.

Method Summary

Modifier and Type	Method	Description
static Transport	getByIdentifier(String identifier)	Returns a Transport by its identifier.
String	getIdentifier()	Gets the low level identifier for the transport.
static Transport	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Transport[]	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

WEBSOCKET

public static final Transport WEBSOCKET

Websocket.

WEBSOCKET_XHR

public static final Transport WEBSOCKET_XHR

Websocket for server to client, XHR for client to server.

LONG_POLLING

public static final Transport LONG_POLLING

HTTP long polling.

Method Details

values

public static Transport[] 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 Transport 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

getIdentifier

public String getIdentifier()

Gets the low level identifier for the transport.

Returns:

the low level transport identifier

getByIdentifier

public static Transport getByIdentifier(String identifier)

Returns a Transport by its identifier. Returns null if no value is found for the given identifier.

Parameters:

identifier - the transport identifier, as returned by getIdentifier()

Returns:

the transport identified by the identifier or null if no matching transport was found