org.apache.brooklyn.core.sensor

Class DependentConfiguration.Builder<T,V>

java.lang.Object

org.apache.brooklyn.core.sensor.DependentConfiguration.Builder<T,V>

Enclosing class:

DependentConfiguration

public static class DependentConfiguration.Builder<T,V>
extends java.lang.Object

Builder for producing variants of attributeWhenReady.

Method Summary

Modifier and Type	Method and Description
<T2> DependentConfiguration.Builder<T,V>	abortIf(Entity source, AttributeSensor<T2> sensor)
<T2> DependentConfiguration.Builder<T,V>	abortIf(Entity source, AttributeSensor<T2> sensor, com.google.common.base.Predicate<? super T2> predicate)
DependentConfiguration.Builder<T,V>	abortIfOnFire() Causes the depender to abort immediately if Attributes.SERVICE_STATE_ACTUAL is Lifecycle.ON_FIRE.
<T2> DependentConfiguration.Builder<T2,T2>	attributeWhenReady(Entity source, AttributeSensor<T2> sensor) Deprecated. since 0.7.0 use DependentConfiguration.builder() then DependentConfiguration.ProtoBuilder.attributeWhenReady(Entity, AttributeSensor) then abortIfOnFire()
DependentConfiguration.Builder<T,V>	blockingDetails(java.lang.String val)
Task<V>	build()
DependentConfiguration.Builder<T,V>	onTimeoutReturn(V val)
DependentConfiguration.Builder<T,V>	onTimeoutThrow()
DependentConfiguration.Builder<T,V>	onUnmanagedContinue() Deprecated.
DependentConfiguration.Builder<T,V>	onUnmanagedReturn(V val)
DependentConfiguration.Builder<T,V>	onUnmanagedThrow()
<V2> DependentConfiguration.Builder<T,V2>	postProcess(groovy.lang.Closure<V2> val)
<V2> DependentConfiguration.Builder<T,V2>	postProcess(com.google.common.base.Function<? super T,V2> val)
DependentConfiguration.Builder<T,V>	readiness(groovy.lang.Closure<java.lang.Boolean> val)
DependentConfiguration.Builder<T,V>	readiness(com.google.common.base.Predicate<? super T> val)
V	runNow()
DependentConfiguration.Builder<T,V>	timeout(Duration val) specifies an optional timeout; by default it waits forever, or until unmanaged or other abort condition
<T2> DependentConfiguration.Builder<T,V>	timeoutIf(Entity source, AttributeSensor<T2> sensor, com.google.common.base.Predicate<? super T2> predicate, Duration val) specifies the supplied timeout if the condition is met
DependentConfiguration.Builder<T,V>	timeoutIfStoppingOrDestroyed(Duration time) Causes the depender to timeout after the given time if Attributes.SERVICE_STATE_ACTUAL is one of Lifecycle.STOPPING, Lifecycle.STOPPED, or Lifecycle.DESTROYED.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

attributeWhenReady

public <T2> DependentConfiguration.Builder<T2,T2> attributeWhenReady(Entity source,
                                                                     AttributeSensor<T2> sensor)

Deprecated. since 0.7.0 use DependentConfiguration.builder() then DependentConfiguration.ProtoBuilder.attributeWhenReady(Entity, AttributeSensor) then abortIfOnFire()

Will wait for the attribute on the given entity. If that entity report Lifecycle.ON_FIRE for its Attributes.SERVICE_STATE_ACTUAL then it will abort.

readiness

public DependentConfiguration.Builder<T,V> readiness(groovy.lang.Closure<java.lang.Boolean> val)

readiness

public DependentConfiguration.Builder<T,V> readiness(com.google.common.base.Predicate<? super T> val)

postProcess

public <V2> DependentConfiguration.Builder<T,V2> postProcess(groovy.lang.Closure<V2> val)

postProcess

public <V2> DependentConfiguration.Builder<T,V2> postProcess(com.google.common.base.Function<? super T,V2> val)

abortIf

public <T2> DependentConfiguration.Builder<T,V> abortIf(Entity source,
                                                        AttributeSensor<T2> sensor)

abortIf

public <T2> DependentConfiguration.Builder<T,V> abortIf(Entity source,
                                                        AttributeSensor<T2> sensor,
                                                        com.google.common.base.Predicate<? super T2> predicate)

abortIfOnFire

public DependentConfiguration.Builder<T,V> abortIfOnFire()

Causes the depender to abort immediately if Attributes.SERVICE_STATE_ACTUAL is Lifecycle.ON_FIRE.

timeoutIfStoppingOrDestroyed

public DependentConfiguration.Builder<T,V> timeoutIfStoppingOrDestroyed(Duration time)

Causes the depender to timeout after the given time if Attributes.SERVICE_STATE_ACTUAL is one of Lifecycle.STOPPING, Lifecycle.STOPPED, or Lifecycle.DESTROYED.

blockingDetails

public DependentConfiguration.Builder<T,V> blockingDetails(java.lang.String val)

timeout

public DependentConfiguration.Builder<T,V> timeout(Duration val)

specifies an optional timeout; by default it waits forever, or until unmanaged or other abort condition

timeoutIf

public <T2> DependentConfiguration.Builder<T,V> timeoutIf(Entity source,
                                                          AttributeSensor<T2> sensor,
                                                          com.google.common.base.Predicate<? super T2> predicate,
                                                          Duration val)

specifies the supplied timeout if the condition is met

onTimeoutReturn

public DependentConfiguration.Builder<T,V> onTimeoutReturn(V val)

onTimeoutThrow

public DependentConfiguration.Builder<T,V> onTimeoutThrow()

onUnmanagedReturn

public DependentConfiguration.Builder<T,V> onUnmanagedReturn(V val)

onUnmanagedThrow

public DependentConfiguration.Builder<T,V> onUnmanagedThrow()

onUnmanagedContinue

@Deprecated
public DependentConfiguration.Builder<T,V> onUnmanagedContinue()

Deprecated.

Since:

0.7.0 included in case old behaviour of not checking whether the entity is managed is required (I can't see why it is; polling will likely give errors, once it is unmanaged this will never completed, and before management the current code will continue, so long as there are no other errors)

build

public Task<V> build()

runNow

public V runNow()