org.apache.brooklyn.core.entity

Class AbstractEntity.BasicSensorSupport

java.lang.Object

org.apache.brooklyn.core.entity.AbstractEntity.BasicSensorSupport

All Implemented Interfaces:

Entity.SensorSupport, EntityInternal.SensorSupportInternal

Enclosing class:

AbstractEntity

@Beta
public class AbstractEntity.BasicSensorSupport
extends java.lang.Object
implements EntityInternal.SensorSupportInternal

Direct use of this class is strongly discouraged. It will become private in a future release, once Entity.sensors() is reverted to return SensorSupport instead of AbstractEntity.BasicSensorSupport.

Constructor Summary

Constructors

Constructor and Description
BasicSensorSupport()

Method Summary

Modifier and Type	Method and Description
<T> void	emit(Sensor<T> sensor, T val) Emits a SensorEvent event on behalf of this entity (as though produced by this entity).
<T> void	emitInternal(Sensor<T> sensor, T val)
<T> T	get(AttributeSensor<T> attribute) Gets the value of the given attribute on this entity, or null if has not been set.
java.util.Map<AttributeSensor<?>,java.lang.Object>	getAll()
<T> T	modify(AttributeSensor<T> attribute, com.google.common.base.Function<? super T,Maybe<T>> modifier) Atomically modifies the AttributeSensor, ensuring that only one modification is done at a time.
void	remove(AttributeSensor<?> attribute)
<T> T	set(AttributeSensor<T> attribute, T val) Sets the AttributeSensor data for the given attribute to the specified value.
<T> T	setWithoutPublishing(AttributeSensor<T> attribute, T val) Like EntityLocal.setAttribute(AttributeSensor, Object), except does not publish an attribute-change event.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicSensorSupport

public BasicSensorSupport()

Method Detail

get

public <T> T get(AttributeSensor<T> attribute)

Description copied from interface: Entity.SensorSupport

Gets the value of the given attribute on this entity, or null if has not been set. Attributes can be things like workrate and status information, as well as configuration (e.g. url/jmxHost/jmxPort), etc.

Specified by:

get in interface Entity.SensorSupport

set

public <T> T set(AttributeSensor<T> attribute,
                 T val)

Description copied from interface: Entity.SensorSupport

Sets the AttributeSensor data for the given attribute to the specified value. This can be used to "enrich" the entity, such as adding aggregated information, rolling averages, etc.

Specified by:

set in interface Entity.SensorSupport

Returns:

the old value for the attribute (possibly null)

setWithoutPublishing

public <T> T setWithoutPublishing(AttributeSensor<T> attribute,
                                  T val)

Description copied from interface: EntityInternal.SensorSupportInternal

Like EntityLocal.setAttribute(AttributeSensor, Object), except does not publish an attribute-change event.

Specified by:

setWithoutPublishing in interface EntityInternal.SensorSupportInternal

modify

@Beta
public <T> T modify(AttributeSensor<T> attribute,
                          com.google.common.base.Function<? super T,Maybe<T>> modifier)

Description copied from interface: Entity.SensorSupport

Atomically modifies the AttributeSensor, ensuring that only one modification is done at a time. If the modifier returns Maybe.absent() then the attribute will be left unmodified, and the existing value will be returned. For details of the synchronization model used to achieve this, refer to the underlying attribute store (e.g. AttributeMap).

Specified by:

modify in interface Entity.SensorSupport

Returns:

the old value for the attribute (possibly null)

remove

public void remove(AttributeSensor<?> attribute)

Specified by:

remove in interface EntityInternal.SensorSupportInternal

getAll

public java.util.Map<AttributeSensor<?>,java.lang.Object> getAll()

Specified by:

getAll in interface EntityInternal.SensorSupportInternal

emit

public <T> void emit(Sensor<T> sensor,
                     T val)

Description copied from interface: Entity.SensorSupport

Emits a SensorEvent event on behalf of this entity (as though produced by this entity).

Note that for attribute sensors it is nearly always recommended to use setAttribute, as this method will not update local values.

Specified by:

emit in interface Entity.SensorSupport

emitInternal

public <T> void emitInternal(Sensor<T> sensor,
                             T val)