Package arez

Class Observer.Flags

java.lang.Object

arez.Observer.Flags

Enclosing class:

Observer

public static final class Observer.Flags
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AREZ_DEPENDENCIES	Flag set set if the application code can not invoke the Observer.reportStale() method.
static final int	AREZ_OR_EXTERNAL_DEPENDENCIES	Flag set if the application code can invoke the Observer.reportStale() method to indicate that a non-arez dependency has changed.
static final int	AREZ_OR_NO_DEPENDENCIES	Flag set set if the application code can not invokethe Observer.reportStale() method to indicate that a dependency has changed.
static final int	KEEPALIVE	The runtime will keep the observer reacting to dependencies until disposed.
static final int	NESTED_ACTIONS_ALLOWED	Indicates that the an action can be created from within the Observers observed function.
static final int	NESTED_ACTIONS_DISALLOWED	Indicates that the an action must not be created from within the Observers observed function.
static final int	NO_REPORT_RESULT	The flag can be passed to actions or observers to force the action to not report result to spy infrastructure.
static final int	OBSERVE_LOWER_PRIORITY_DEPENDENCIES	Flag indicating that the Observer is allowed to observe ComputableValue instances with a lower priority.
static final int	PRIORITY_HIGH	High priority.
static final int	PRIORITY_HIGHEST	Highest priority.
static final int	PRIORITY_LOW	Low priority.
static final int	PRIORITY_LOWEST	Lowest priority.
static final int	PRIORITY_MASK	Mask used to extract priority bits.
static final int	PRIORITY_NORMAL	Normal priority if no other priority otherwise specified.
static final int	READ_ONLY	The observer can only read arez state.
static final int	READ_WRITE	The observer can read or write arez state.
static final int	RUN_LATER	The scheduler will not be triggered when the observer is created.
static final int	RUN_NOW	The scheduler will be triggered when the observer is created to immediately invoke the Observer._observe function.

Constructor Summary

Constructors

Constructor	Description
Flags()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_REPORT_RESULT

public static final int NO_REPORT_RESULT

The flag can be passed to actions or observers to force the action to not report result to spy infrastructure.

See Also:

• Constant Field Values

PRIORITY_HIGHEST

public static final int PRIORITY_HIGHEST

Highest priority. This priority should be used when the observer will dispose or release other reactive elements (and thus remove elements from being scheduled).

Only one of the PRIORITY_* flags should be applied to observer.

See Also:

• Priority.HIGHEST
• Priority.HIGHEST
• Task.Flags.PRIORITY_HIGHEST
• Constant Field Values

PRIORITY_HIGH

public static final int PRIORITY_HIGH

High priority. To reduce the chance that downstream elements will react multiple times within a single reaction round, this priority should be used when the observer may trigger many downstream reactions.

Only one of the PRIORITY_* flags should be applied to observer.

See Also:

• Priority.HIGH
• Priority.HIGH
• Task.Flags.PRIORITY_HIGH
• Constant Field Values

PRIORITY_NORMAL

public static final int PRIORITY_NORMAL

Normal priority if no other priority otherwise specified.

Only one of the PRIORITY_* flags should be applied to observer.

See Also:

• Priority.NORMAL
• Priority.NORMAL
• Task.Flags.PRIORITY_NORMAL
• Constant Field Values

PRIORITY_LOW

public static final int PRIORITY_LOW

Low priority. Usually used to schedule observers that reflect state onto non-reactive application components. i.e. Observers that are used to build html views, perform network operations etc. These reactions are often at low priority to avoid recalculation of dependencies (i.e. ComputableValues) triggering this reaction multiple times within a single reaction round.

Only one of the PRIORITY_* flags should be applied to observer.

See Also:

• Priority.LOW
• Priority.LOW
• Task.Flags.PRIORITY_LOW
• Constant Field Values

PRIORITY_LOWEST

public static final int PRIORITY_LOWEST

Lowest priority. Use this priority if the observer is a ComputableValue that may be unobserved when a PRIORITY_LOW observer reacts. This is used to avoid recomputing state that is likely to either be unobserved or recomputed as part of another observers reaction.

Only one of the PRIORITY_* flags should be applied to observer.

See Also:

• Priority.LOWEST
• Priority.LOWEST
• Task.Flags.PRIORITY_LOWEST
• Constant Field Values

PRIORITY_MASK

public static final int PRIORITY_MASK

Mask used to extract priority bits.

See Also:

• Constant Field Values

READ_ONLY

public static final int READ_ONLY

The observer can only read arez state.

See Also:

• Constant Field Values

READ_WRITE

public static final int READ_WRITE

The observer can read or write arez state.

See Also:

• Constant Field Values

RUN_NOW

public static final int RUN_NOW

The scheduler will be triggered when the observer is created to immediately invoke the Observer._observe function. This configuration should not be specified if there is no Observer._observe function supplied. This should not be specified if RUN_LATER is specified.

See Also:

• Constant Field Values

RUN_LATER

public static final int RUN_LATER

The scheduler will not be triggered when the observer is created. The observer either has no Observer._observe function or is responsible for ensuring that ArezContext.triggerScheduler() is invoked at a later time. This should not be specified if RUN_NOW is specified.

See Also:

• Constant Field Values

OBSERVE_LOWER_PRIORITY_DEPENDENCIES

public static final int OBSERVE_LOWER_PRIORITY_DEPENDENCIES

Flag indicating that the Observer is allowed to observe ComputableValue instances with a lower priority.

See Also:

• Constant Field Values

NESTED_ACTIONS_ALLOWED

public static final int NESTED_ACTIONS_ALLOWED

Indicates that the an action can be created from within the Observers observed function.

See Also:

• Constant Field Values

NESTED_ACTIONS_DISALLOWED

public static final int NESTED_ACTIONS_DISALLOWED

Indicates that the an action must not be created from within the Observers observed function.

See Also:

• Constant Field Values

AREZ_DEPENDENCIES

public static final int AREZ_DEPENDENCIES

Flag set set if the application code can not invoke the Observer.reportStale() method.

See Also:

• DepType.AREZ
• Constant Field Values

AREZ_OR_NO_DEPENDENCIES

public static final int AREZ_OR_NO_DEPENDENCIES

Flag set set if the application code can not invokethe Observer.reportStale() method to indicate that a dependency has changed. In this scenario it is not an error if the observer does not invoke the ObservableValue.reportObserved() on a dependency during it's reaction.

See Also:

• DepType.AREZ_OR_NONE
• Constant Field Values

AREZ_OR_EXTERNAL_DEPENDENCIES

public static final int AREZ_OR_EXTERNAL_DEPENDENCIES

Flag set if the application code can invoke the Observer.reportStale() method to indicate that a non-arez dependency has changed.

See Also:

• DepType.AREZ_OR_EXTERNAL
• Constant Field Values

KEEPALIVE

public static final int KEEPALIVE

The runtime will keep the observer reacting to dependencies until disposed. This is the default value for observers that supply a observed function.

See Also:

• Constant Field Values

Constructor Details

Flags

public Flags()