Package sprouts

Enum Class From

java.lang.Object

java.lang.Enum<From>

sprouts.From

All Implemented Interfaces:

Serializable, Comparable<From>, Constable, Channel

public enum From
extends Enum<From>
implements Channel

An implementation of the Channel marker interface which is used to identify the source of a change in a Var or Val property.

This is typically used by the Viewable.onChange(Channel, Action) method to register an Action callback for a particular Channel constant (like for example VIEW_MODEL or VIEW) which will then be invoked when the Val.fireChange(Channel) method or the Var.set(Channel, Object) method is called using the same Channel as previously used to register the callback.

Note that the Var.set(Object) method defaults to using the VIEW_MODEL channel, which is intended to be used for state changes as part of your core business logic, in your view model.

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
ALL	This channel is used to identify changes which are caused by any source.
VIEW	This channel is used to identify changes which are caused by the user through the view layer.
VIEW_MODEL	This channel is used to identify changes which are caused by the view model through the view model layer.

Method Summary

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

VIEW

public static final From VIEW

This channel is used to identify changes which are caused by the user through the view layer.

VIEW_MODEL

public static final From VIEW_MODEL

This channel is used to identify changes which are caused by the view model through the view model layer.

ALL

public static final From ALL

This channel is used to identify changes which are caused by any source.

Method Details

values

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