Field Detail

• REAL_QUICK_WAIT

  public static Duration REAL_QUICK_WAIT

  Period to wait if we're expected to return real quick but we want fast things to have time to finish.

  Timings are always somewhat arbitrary but this at least allows some intention to be captured in code rather than arbitrary values.

• PRETTY_QUICK_WAIT

  public static Duration PRETTY_QUICK_WAIT

  Period to wait if we're expected to return quickly but we want to be a bit more generous for things to finish, without letting a caller get annoyed.

  See REAL_QUICK_WAIT.

• REAL_QUICK_PERIOD

  public static Duration REAL_QUICK_PERIOD

  Period to wait when we have to poll but want to give the illusion of no wait. See Repeater.DEFAULT_REAL_QUICK_PERIOD

Method Detail

• clone

  public ValueResolver<T> clone()

  returns a copy of this resolver which can be queried, even if the original (single-use instance) has already been copied

  Overrides:

  clone in class java.lang.Object

• context

  public ValueResolver<T> context(ExecutionContext exec)

  execution context to use when resolving; required if resolving unsubmitted tasks or running with a time limit

• context

  public ValueResolver<T> context(Entity entity)

  as context(ExecutionContext) for use from an entity

• description

  public ValueResolver<T> description(java.lang.String description)

  sets a message which will be displayed in status reports while it waits (e.g. the name of the config key being looked up)

• defaultValue

  public ValueResolver<T> defaultValue(T defaultValue)

  sets a default value which will be returned on a call to get() if the task does not complete or completes with an error

  note that getMaybe() returns an absent object even in the presence of a default, so that any error can still be accessed

• noDefaultValue

  public ValueResolver<T> noDefaultValue()

  indicates that no default value should be returned on a call to get(), and instead it should throw (this is the default; this method is provided to undo a call to defaultValue(Object))

• swallowExceptions

  public ValueResolver<T> swallowExceptions()

  indicates that exceptions in resolution should not be thrown on a call to getMaybe(), but rather used as part of the Maybe.get() if it's absent, and swallowed altogether on a call to get() in the presence of a defaultValue(Object)

• transientTask

  public ValueResolver<T> transientTask(boolean isTransientTask)

  whether the task should be marked as transient; defaults true

• getDefault

  public Maybe<T> getDefault()

• deep

  public ValueResolver<T> deep(boolean forceDeep)

  causes nested structures (maps, lists) to be descended and nested unresolved values resolved

• embedResolutionInTask

  public ValueResolver<T> embedResolutionInTask(java.lang.Boolean embedResolutionInTask)

  if true, forces execution of a deferred supplier to be run in a task; if false, it prevents it (meaning time limits may not be applied); if null, the default, it runs in a task if a time limit is applied.

  running inside a task is required for some DeferredSupplier instances which look up a task ExecutionContext.

• timeout

  public ValueResolver<T> timeout(Duration timeout)

  sets a time limit on executions

  used for Task and DeferredSupplier instances. may require an execution context at runtime.

• get

  public T get()

  Specified by:

  get in interface DeferredSupplier<T>

  Specified by:

  get in interface com.google.common.base.Supplier<T>

• getMaybe

  public Maybe<T> getMaybe()

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object