org.apache.brooklyn.core.entity

Class EntityDynamicType

java.lang.Object

org.apache.brooklyn.core.objs.BrooklynDynamicType<Entity,AbstractEntity>

org.apache.brooklyn.core.entity.EntityDynamicType

public class EntityDynamicType
extends BrooklynDynamicType<Entity,AbstractEntity>

This is the actual type of an entity instance at runtime, which can change from the static EntityType, and can change over time; for this reason it does *not* implement EntityType, but callers can call getSnapshot() to get a snapshot such instance

Constructor Summary

Constructors

Constructor and Description
EntityDynamicType(AbstractEntity entity)
EntityDynamicType(java.lang.Class<? extends Entity> clazz)

Method Summary

Modifier and Type	Method and Description
void	addConfigKey(ConfigKey<?> newKey) Adds the given ConfigKey to this entity.
void	addConfigKeys(java.lang.Iterable<ConfigKey<?>> newKeys) Adds the given ConfigKey to this entity.
void	addEffector(Effector<?> newEffector) Adds the given Effector to this entity.
<T> void	addEffector(Effector<T> effector, EffectorBody<T> body) Adds an effector with an explicit body to this entity.
<T> void	addEffector(Effector<T> effector, EffectorTasks.EffectorTaskFactory<T> body) Adds an effector with an explicit body to this entity.
void	addSensor(Sensor<?> newSensor) Adds the given Sensor to this entity.
void	addSensorIfAbsent(Sensor<?> newSensor)
Sensor<?>	addSensorIfAbsentWithoutPublishing(Sensor<?> newSensor)
void	addSensors(java.lang.Iterable<? extends Sensor<?>> newSensors) Adds the given Sensors to this entity.
static java.util.Map<java.lang.String,Effector<?>>	findEffectors(java.lang.Class<? extends Entity> clazz, Entity optionalEntity) Finds the effectors defined on the entity's class, statics and optionally any non-static (discouraged).
static java.util.Map<java.lang.String,Sensor<?>>	findSensors(java.lang.Class<? extends Entity> clazz, Entity optionalEntity) Finds the sensors defined on the entity's class, statics and optionally any non-static (discouraged).
Effector<?>	getEffector(java.lang.String name)
java.util.Map<java.lang.String,Effector<?>>	getEffectors() Effectors available on this entity.
java.lang.Class<? extends Entity>	getEntityClass() Deprecated. since 0.7; unused code; instead use BrooklynDynamicType.getBrooklynClass()
Sensor<?>	getSensor(java.lang.String sensorName) Convenience for finding named sensor.
java.util.Map<java.lang.String,Sensor<?>>	getSensors() Sensors available on this entity.
EntityType	getSnapshot()
boolean	removeConfigKey(ConfigKey<?> key) Removes the named ConfigKey from this entity.
void	removeEffector(Effector<?> effector) Removes the given Effector from this entity.
boolean	removeSensor(Sensor<?> sensor) Removes the named Sensor from this entity.
Sensor<?>	removeSensor(java.lang.String sensorName) Removes the named Sensor from this entity.

Methods inherited from class org.apache.brooklyn.core.objs.BrooklynDynamicType

getBrooklynClass, getConfigKey, getConfigKeyField, getConfigKeys, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDynamicType

public EntityDynamicType(AbstractEntity entity)

EntityDynamicType

public EntityDynamicType(java.lang.Class<? extends Entity> clazz)

Method Detail

getEntityClass

@Deprecated
public java.lang.Class<? extends Entity> getEntityClass()

Deprecated. since 0.7; unused code; instead use BrooklynDynamicType.getBrooklynClass()

getSnapshot

public EntityType getSnapshot()

Overrides:

getSnapshot in class BrooklynDynamicType<Entity,AbstractEntity>

getEffector

public Effector<?> getEffector(java.lang.String name)

Returns:

the effector with the given name, or null if not found

getEffectors

public java.util.Map<java.lang.String,Effector<?>> getEffectors()

Effectors available on this entity.

addEffector

@Beta
public void addEffector(Effector<?> newEffector)

Adds the given Effector to this entity.

addEffector

@Beta
public <T> void addEffector(Effector<T> effector,
                                  EffectorTasks.EffectorTaskFactory<T> body)

Adds an effector with an explicit body to this entity.

addEffector

@Beta
public <T> void addEffector(Effector<T> effector,
                                  EffectorBody<T> body)

Adds an effector with an explicit body to this entity.

removeEffector

@Beta
public void removeEffector(Effector<?> effector)

Removes the given Effector from this entity.

Note that if the argument is an instance of EffectorWithBody it will still be possible to invoke the effector on the entity by calling entity.invoke(effector, argumentsMap).

getSensors

public java.util.Map<java.lang.String,Sensor<?>> getSensors()

Sensors available on this entity.

getSensor

public Sensor<?> getSensor(java.lang.String sensorName)

Convenience for finding named sensor.

addSensor

public void addSensor(Sensor<?> newSensor)

Adds the given Sensor to this entity.

addSensors

public void addSensors(java.lang.Iterable<? extends Sensor<?>> newSensors)

Adds the given Sensors to this entity.

addSensorIfAbsent

public void addSensorIfAbsent(Sensor<?> newSensor)

addSensorIfAbsentWithoutPublishing

public Sensor<?> addSensorIfAbsentWithoutPublishing(Sensor<?> newSensor)

removeSensor

public Sensor<?> removeSensor(java.lang.String sensorName)

Removes the named Sensor from this entity.

removeSensor

public boolean removeSensor(Sensor<?> sensor)

Removes the named Sensor from this entity.

addConfigKey

public void addConfigKey(ConfigKey<?> newKey)

Adds the given ConfigKey to this entity.

addConfigKeys

public void addConfigKeys(java.lang.Iterable<ConfigKey<?>> newKeys)

Adds the given ConfigKey to this entity.

removeConfigKey

public boolean removeConfigKey(ConfigKey<?> key)

Removes the named ConfigKey from this entity.

findEffectors

public static java.util.Map<java.lang.String,Effector<?>> findEffectors(java.lang.Class<? extends Entity> clazz,
                                                                        Entity optionalEntity)

Finds the effectors defined on the entity's class, statics and optionally any non-static (discouraged).

findSensors

public static java.util.Map<java.lang.String,Sensor<?>> findSensors(java.lang.Class<? extends Entity> clazz,
                                                                    Entity optionalEntity)

Finds the sensors defined on the entity's class, statics and optionally any non-static (discouraged).