com.vaadin.flow.templatemodel

Enum ClientUpdateMode

java.lang.Object

java.lang.Enum<ClientUpdateMode>

com.vaadin.flow.templatemodel.ClientUpdateMode

All Implemented Interfaces:

Serializable, Comparable<ClientUpdateMode>

public enum ClientUpdateMode
extends Enum<ClientUpdateMode>

A mode for whether a model property may be updated from the client.

Since:

1.0

Author:

Vaadin Ltd

See Also:

AllowClientUpdates

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW Always allow updating the property.
DENY Never allow updating the property.
IF_TWO_WAY_BINDING Allow updating the property if there is a corresponding two-way binding in the template.

Method Summary

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

ALLOW

public static final ClientUpdateMode ALLOW

Always allow updating the property.

DENY

public static final ClientUpdateMode DENY

Never allow updating the property.

IF_TWO_WAY_BINDING

public static final ClientUpdateMode IF_TWO_WAY_BINDING

Allow updating the property if there is a corresponding two-way binding in the template. This is the default mode that is used if nothing else has been defined for a property.

Method Detail

values

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

Returns:

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

valueOf

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