org.apache.brooklyn.camp.brooklyn.spi.dsl

Class DslDeferredFunctionCall

java.lang.Object

org.apache.brooklyn.camp.brooklyn.spi.dsl.BrooklynDslDeferredSupplier<java.lang.Object>

org.apache.brooklyn.camp.brooklyn.spi.dsl.DslDeferredFunctionCall

All Implemented Interfaces:

java.io.Serializable, TaskFactory<Task<java.lang.Object>>, DeferredSupplier<java.lang.Object>, ImmediateSupplier<java.lang.Object>

public class DslDeferredFunctionCall
extends BrooklynDslDeferredSupplier<java.lang.Object>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.util.core.task.ImmediateSupplier

ImmediateSupplier.ImmediateUnsupportedException, ImmediateSupplier.ImmediateValueNotAvailableException

Constructor Summary

Constructors

Constructor and Description
DslDeferredFunctionCall(java.lang.Object o, java.lang.String fn, java.util.List<java.lang.Object> args)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Maybe<java.lang.Object>	getImmediately() Gets the value promptly, or returns Maybe.absent() if the value requires blocking, or throws ImmediateSupplier.ImmediateUnsupportedException if it cannot be determined whether the value requires blocking or not.
int	hashCode()
Task<java.lang.Object>	newTask()
java.lang.String	toString()

Methods inherited from class org.apache.brooklyn.camp.brooklyn.spi.dsl.BrooklynDslDeferredSupplier

get

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DslDeferredFunctionCall

public DslDeferredFunctionCall(java.lang.Object o,
                               java.lang.String fn,
                               java.util.List<java.lang.Object> args)

Method Detail

getImmediately

public Maybe<java.lang.Object> getImmediately()

Description copied from interface: ImmediateSupplier

Gets the value promptly, or returns Maybe.absent() if the value requires blocking, or throws ImmediateSupplier.ImmediateUnsupportedException if it cannot be determined whether the value requires blocking or not.

The Maybe.absent() returned here indicates that a value definitively is pending, just it is not yet available, and an attempt to Maybe.get() it should throw an ImmediateSupplier.ImmediateValueNotAvailableException; it can be created with ImmediateSupplier.ImmediateValueNotAvailableException.newAbsentWithExceptionSupplier() to avoid creating traces (or simply with Maybe.absent(new ImmediateValueNotAvailableException(...))). This is in contrast with this method throwing a ImmediateSupplier.ImmediateUnsupportedException which should be done if the presence of an eventual value cannot even be determined in a non-blocking way.

Implementations of this method should typically catch the former exception if encountered and return a Maybe.absent() wrapping it, whereas ImmediateSupplier.ImmediateUnsupportedException instances should be propagated.

newTask

public Task<java.lang.Object> newTask()

Specified by:

newTask in interface TaskFactory<Task<java.lang.Object>>

Specified by:

newTask in class BrooklynDslDeferredSupplier<java.lang.Object>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object