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

Class DslComponent

java.lang.Object

org.apache.brooklyn.camp.brooklyn.spi.dsl.BrooklynDslDeferredSupplier<Entity>

org.apache.brooklyn.camp.brooklyn.spi.dsl.methods.DslComponent

All Implemented Interfaces:

com.google.common.base.Supplier<Entity>, java.io.Serializable, TaskFactory<Task<Entity>>, DslFunctionSource, DeferredSupplier<Entity>, ImmediateSupplier<Entity>

public class DslComponent
extends BrooklynDslDeferredSupplier<Entity>
implements DslFunctionSource

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DslComponent.Scope

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

ImmediateSupplier.ImmediateUnsupportedException, ImmediateSupplier.ImmediateValueNotAvailableException

Constructor Summary

Constructors

Constructor and Description
DslComponent(DslComponent.Scope scope) Resolve in scope relative to the current BrooklynTaskTags#getTargetOrContextEntity) target or context entity (where the scope defines an unambiguous relationship that will resolve to a single component - e.g.
DslComponent(DslComponent.Scope scope, DeferredSupplier<?> componentIdSupplier)
DslComponent(DslComponent.Scope scope, java.lang.String componentId) Resolve componentId in scope relative to the current BrooklynTaskTags#getTargetOrContextEntity) target or context entity.
DslComponent(DslComponent scopeComponent, DslComponent.Scope scope) Resolve in scope relative to scopeComponent entity (where the scope defines an unambiguous relationship that will resolve to a single component - e.g.
DslComponent(DslComponent scopeComponent, DslComponent.Scope scope, DeferredSupplier<?> componentIdSupplier) Resolve componentId in scope relative to scopeComponent.
DslComponent(DslComponent scopeComponent, DslComponent.Scope scope, java.lang.String componentId) Resolve componentId in scope relative to scopeComponent.
DslComponent(java.lang.String componentId) Deprecated. since 0.10.0; pass the DslComponent.Scope explicitly.

Method Summary

Modifier and Type	Method and Description
DslComponent	ancestor(java.lang.Object id)
BrooklynDslDeferredSupplier<?>	attributeWhenReady(java.lang.Object sensorNameOrSupplier)
DslComponent	child(java.lang.Object id)
DslComponent	component(java.lang.Object id) Deprecated.
DslComponent	component(java.lang.String scope, java.lang.Object id)
BrooklynDslDeferredSupplier<?>	config(java.lang.Object keyNameOrSupplier)
DslComponent	descendant(java.lang.Object id)
DslComponent	entity(java.lang.Object id)
BrooklynDslDeferredSupplier<?>	entityId()
boolean	equals(java.lang.Object obj)
Maybe<Entity>	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.
DslComponent.Scope	getScope()
int	hashCode()
static DslComponent	newInstance(DslComponent.Scope scope, java.lang.Object componentId) Checks the type of componentId to create the right kind of DslComponent (based on whether the componentId is already resolved.
static DslComponent	newInstance(DslComponent scopeComponent, DslComponent.Scope scope, java.lang.Object componentId) Checks the type of componentId to create the right kind of DslComponent (based on whether the componentId is already resolved.
Task<Entity>	newTask()
DslComponent	parent()
DslComponent	root()
DslComponent	scopeRoot()
DslComponent	self()
BrooklynDslDeferredSupplier<Sensor<?>>	sensor(java.lang.Object sensorIndicator)
DslComponent	sibling(java.lang.Object id)
java.lang.Object	template(java.lang.Object template)
java.lang.Object	template(java.lang.Object template, java.util.Map<?,?> substitutions)
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

DslComponent

@Deprecated
public DslComponent(java.lang.String componentId)

Deprecated. since 0.10.0; pass the DslComponent.Scope explicitly.

Resolve componentId in the DslComponent.Scope.GLOBAL scope.

DslComponent

public DslComponent(DslComponent.Scope scope)

Resolve in scope relative to the current BrooklynTaskTags#getTargetOrContextEntity) target or context entity (where the scope defines an unambiguous relationship that will resolve to a single component - e.g. "parent").

DslComponent

public DslComponent(DslComponent scopeComponent,
                    DslComponent.Scope scope)

Resolve in scope relative to scopeComponent entity (where the scope defines an unambiguous relationship that will resolve to a single component - e.g. "parent").

DslComponent

public DslComponent(DslComponent.Scope scope,
                    java.lang.String componentId)

Resolve componentId in scope relative to the current BrooklynTaskTags#getTargetOrContextEntity) target or context entity.

DslComponent

public DslComponent(DslComponent.Scope scope,
                    DeferredSupplier<?> componentIdSupplier)

DslComponent

public DslComponent(DslComponent scopeComponent,
                    DslComponent.Scope scope,
                    java.lang.String componentId)

Resolve componentId in scope relative to scopeComponent.

DslComponent

public DslComponent(DslComponent scopeComponent,
                    DslComponent.Scope scope,
                    DeferredSupplier<?> componentIdSupplier)

Resolve componentId in scope relative to scopeComponent.

Method Detail

newInstance

public static DslComponent newInstance(DslComponent scopeComponent,
                                       DslComponent.Scope scope,
                                       java.lang.Object componentId)

Checks the type of componentId to create the right kind of DslComponent (based on whether the componentId is already resolved. Accepts either a String or a DeferredSupplier.

newInstance

public static DslComponent newInstance(DslComponent.Scope scope,
                                       java.lang.Object componentId)

Checks the type of componentId to create the right kind of DslComponent (based on whether the componentId is already resolved. Accepts either a String or a DeferredSupplier.

getScope

public DslComponent.Scope getScope()

getImmediately

public final Maybe<Entity> 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.

Specified by:

getImmediately in interface ImmediateSupplier<Entity>

newTask

public Task<Entity> newTask()

Specified by:

newTask in interface TaskFactory<Task<Entity>>

Specified by:

newTask in class BrooklynDslDeferredSupplier<Entity>

entity

public DslComponent entity(java.lang.Object id)

child

public DslComponent child(java.lang.Object id)

sibling

public DslComponent sibling(java.lang.Object id)

descendant

public DslComponent descendant(java.lang.Object id)

ancestor

public DslComponent ancestor(java.lang.Object id)

root

public DslComponent root()

scopeRoot

public DslComponent scopeRoot()

component

@Deprecated
public DslComponent component(java.lang.Object id)

Deprecated.

self

public DslComponent self()

parent

public DslComponent parent()

component

public DslComponent component(java.lang.String scope,
                              java.lang.Object id)

entityId

public BrooklynDslDeferredSupplier<?> entityId()

attributeWhenReady

public BrooklynDslDeferredSupplier<?> attributeWhenReady(java.lang.Object sensorNameOrSupplier)

config

public BrooklynDslDeferredSupplier<?> config(java.lang.Object keyNameOrSupplier)

sensor

public BrooklynDslDeferredSupplier<Sensor<?>> sensor(java.lang.Object sensorIndicator)

template

public java.lang.Object template(java.lang.Object template)

template

public java.lang.Object template(java.lang.Object template,
                                 java.util.Map<?,?> substitutions)

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