DslComponent (Apache Brooklyn)

java.lang.Object
- io.brooklyn.camp.brooklyn.spi.dsl.BrooklynDslDeferredSupplier<Entity>
- - io.brooklyn.camp.brooklyn.spi.dsl.methods.DslComponent

All Implemented Interfaces:

TaskFactory<Task<Entity>>, DeferredSupplier<Entity>, com.google.common.base.Supplier<Entity>, java.io.Serializable
```
public class DslComponent
extends BrooklynDslDeferredSupplier<Entity>
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DslComponent.Scope

Nested Classes
Modifier and Type	Class and Description
`static class`	`DslComponent.Scope`

Constructor Summary

Constructors
Constructor and Description
`DslComponent(DslComponent.Scope scope, java.lang.String componentId)`
`DslComponent(DslComponent scopeComponent, DslComponent.Scope scope, java.lang.String componentId)`
`DslComponent(java.lang.String componentId)`

Method Summary

Methods
Modifier and Type	Method and Description
`DslComponent`	`ancestor(java.lang.String scopeOrId)`
`BrooklynDslDeferredSupplier<?>`	`attributeWhenReady(java.lang.String sensorName)`
`DslComponent`	`child(java.lang.String scopeOrId)`
`DslComponent`	`component(java.lang.String scopeOrId)` Deprecated.
`DslComponent`	`component(java.lang.String scope, java.lang.String id)`
`BrooklynDslDeferredSupplier<?>`	`config(java.lang.String keyName)`
`DslComponent`	`descendant(java.lang.String scopeOrId)`
`DslComponent`	`entity(java.lang.String scopeOrId)`
`Task<Entity>`	`newTask()`
`DslComponent`	`parent()`
`DslComponent`	`sibling(java.lang.String scopeOrId)`
`java.lang.String`	`toString()`

Methods inherited from class io.brooklyn.camp.brooklyn.spi.dsl.BrooklynDslDeferredSupplier
get

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DslComponent

public DslComponent(java.lang.String componentId)

DslComponent

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

DslComponent

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

Method Detail

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.String scopeOrId)

child

public DslComponent child(java.lang.String scopeOrId)

sibling

public DslComponent sibling(java.lang.String scopeOrId)

descendant

public DslComponent descendant(java.lang.String scopeOrId)

ancestor

public DslComponent ancestor(java.lang.String scopeOrId)

component

@Deprecated
public DslComponent component(java.lang.String scopeOrId)

Deprecated.

parent
```
public DslComponent parent()
```

component

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

attributeWhenReady

public BrooklynDslDeferredSupplier<?> attributeWhenReady(java.lang.String sensorName)

config

public BrooklynDslDeferredSupplier<?> config(java.lang.String keyName)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class DslComponent

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class io.brooklyn.camp.brooklyn.spi.dsl.BrooklynDslDeferredSupplier

Methods inherited from class java.lang.Object

Constructor Detail

DslComponent

DslComponent

DslComponent

Method Detail

newTask

entity

child

sibling

descendant

ancestor

component

parent

component

attributeWhenReady

config

toString