Module org.omnifaces

Package org.omnifaces.cdi

Enum Class Push.Type

java.lang.Object

java.lang.Enum<Push.Type>

org.omnifaces.cdi.Push.Type

All Implemented Interfaces:

Serializable, Comparable<Push.Type>, Constable

Enclosing class:

Push

public static enum Push.Type
extends Enum<Push.Type>

Represents the transport type for push messages.

Since:

5.2

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
NOTIFICATION	Notification transport via <o:notification>.
SOCKET	Web Socket transport via <o:socket>.
SSE	Server-Sent Events transport via <o:sse>.

Method Summary

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

SOCKET

public static final Push.Type SOCKET

Web Socket transport via <o:socket>. This is the default.

SSE

public static final Push.Type SSE

Server-Sent Events transport via <o:sse>.

NOTIFICATION

public static final Push.Type NOTIFICATION

Notification transport via <o:notification>. Uses SSE internally and validates that messages sent through this push context are Notification.Message instances.

Method Details

values

public static Push.Type[] 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 Push.Type 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