xapi.dev.util

Enum DefermentWriter.DefermentStrategy

java.lang.Object

java.lang.Enum<DefermentWriter.DefermentStrategy>

xapi.dev.util.DefermentWriter.DefermentStrategy

All Implemented Interfaces:

Serializable, Comparable<DefermentWriter.DefermentStrategy>

Enclosing class:

DefermentWriter

public static enum DefermentWriter.DefermentStrategy
extends Enum<DefermentWriter.DefermentStrategy>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFERRED Uses Scheduler.get().scheduleDeferred() to push your callback into a new javascript execution thread.
FINALLY Uses Scheduler.get().scheduleFinally() to defer your callback.
NONE The default deferment strategy: none.
TIMER Uses new Timer().schedule() to defer callbacks; this is the more heavyweight option, but it does ensure a completely clean stack; best used for heavyweight processes.
X_PROCESS Uses X_Process.defer(), which is not yet in the public API, but handles execution in any runtime environment.

Method Summary

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

NONE

public static final DefermentWriter.DefermentStrategy NONE

The default deferment strategy: none. If your code depends on asynchronocity, you must choose an explicit deferment strategy

FINALLY

public static final DefermentWriter.DefermentStrategy FINALLY

Uses Scheduler.get().scheduleFinally() to defer your callback. This will ensure that a split point already loaded will execute in the same javascript execution thread, but after all other code on the stack is executed.

DEFERRED

public static final DefermentWriter.DefermentStrategy DEFERRED

Uses Scheduler.get().scheduleDeferred() to push your callback into a new javascript execution thread. This is best for most use case that do not depend on updating the DOM before the UI thread paints the screen.

TIMER

public static final DefermentWriter.DefermentStrategy TIMER

Uses new Timer().schedule() to defer callbacks; this is the more heavyweight option, but it does ensure a completely clean stack; best used for heavyweight processes.

X_PROCESS

public static final DefermentWriter.DefermentStrategy X_PROCESS

Uses X_Process.defer(), which is not yet in the public API, but handles execution in any runtime environment. Use this if you need the generated code to run in a non-gwt JRE.

Method Detail

values

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

Returns:

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

valueOf

public static DefermentWriter.DefermentStrategy 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