com.palantir.ptoss.cinch.core

Enum ModelUpdates

java.lang.Object

java.lang.Enum<ModelUpdates>

com.palantir.ptoss.cinch.core.ModelUpdates

All Implemented Interfaces:

ModelUpdate, java.io.Serializable, java.lang.Comparable<ModelUpdates>

public enum ModelUpdates
extends java.lang.Enum<ModelUpdates>
implements ModelUpdate

Pre-defined ModelUpdate types with special meanings to the framework.

See Also:

Bound, CallOnUpdate

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL This is used to sync all listeners.
DATA You can use this to mean data, as opposed to meta-data.
META This can be used to separate data from meta-data.
UNSPECIFIED This is used for unspecified update types in the default implementations of BindableModel.

Method Summary

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

UNSPECIFIED

public static final ModelUpdates UNSPECIFIED

This is used for unspecified update types in the default implementations of BindableModel. Listeners that don't have a specified "on" parameter should react to these model updates.

Note: when bound to a specific ModelUpdate, a control will not receive updates not sent specifically to any ModelUpdate - i.e. default updates. To selectively answer a specific ModelUpdate and also still get default notications, add UNSPECIFIED to the list of ModelUpdates passed to Bound.on().

See Also:

Bound

ALL

public static final ModelUpdates ALL

This is used to sync all listeners. All listeners, regardless of whether they have an "on" parameter, should react to these model updates.

DATA

public static final ModelUpdates DATA

You can use this to mean data, as opposed to meta-data. No special meaning to the framework.

META

public static final ModelUpdates META

This can be used to separate data from meta-data. No special meaning to the framework.

Method Detail

values

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

Returns:

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

valueOf

public static ModelUpdates valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null