We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.shared.communication.
Enum Class PushMode
All Implemented Interfaces:
The mode of bidirectional ("push") communication that is in use.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionbooleanChecks whether the push mode is using push functionality
static PushModeReturns the enum constant of this class with the specified name.
static PushMode[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
DISABLED
Push is disabled. Regular AJAX requests are used to communicate between the client and the server. Asynchronous messages from the server are not possible.
ui.push()throws IllegalStateException.This is the default mode unless
configuredotherwise. -
MANUAL
Push is enabled. A bidirectional channel is established between the client and server and used to communicate state changes and RPC invocations. The client is not automatically updated if the server-side state is asynchronously changed;
ui.push()must be explicitly called. -
AUTOMATIC
Push is enabled. Like
MANUAL, but asynchronous changes to the server-side state are automatically pushed to the client once the session lock is released.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null -
isEnabled
public boolean isEnabled()Checks whether the push mode is using push functionality
Returns:
trueif this mode requires push functionality;falseif no push functionality is used for this mode.
-