Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.entity.basic
[Java] Class AbstractEffector

java.lang.Object
  brooklyn.entity.effector.EffectorBase
      brooklyn.entity.basic.AbstractEffector
All Implemented Interfaces:
EffectorWithBody
public abstract class AbstractEffector
extends EffectorBase

The abstract Effector implementation. The concrete subclass (often anonymous) will supply the call(Entity, Map) implementation, and the fields in the constructor.

Field Summary
static Logger LOG

@deprecated since 0.6.0 shouldn't be public
 
Constructor Summary
AbstractEffector(java.lang.String name, java.lang.Class returnType, java.util.List parameters, java.lang.String description)

 
Method Summary
java.lang.Object call(Entity entity, java.util.Map parameters)

java.lang.Object call(Entity entity)

Convenience for named-parameter syntax (needs map in first argument)
java.lang.Object call(java.util.Map parameters, Entity entity)

Convenience for named-parameter syntax (needs map in first argument)
EffectorTaskFactory getBody()

not meant for overriding; subclasses should override the abstract call(Entity, Map) method in this class
protected java.util.Map getFlagsForTaskInvocationAt(Entity entity)

subclasses may override to add additional flags, but they should include the flags returned here unless there is very good reason not to
 
Methods inherited from class EffectorBase
getDescription, getName, getParameters, getReturnType, getReturnTypeName, toString
 

Field Detail

LOG

public static final Logger LOG
deprecated:
since 0.6.0 shouldn't be public

 
Constructor Detail

AbstractEffector

public AbstractEffector(java.lang.String name, java.lang.Class returnType, java.util.List parameters, java.lang.String description)

 
Method Detail

call

public java.lang.Object call(Entity entity, @SuppressWarnings("rawtypes") java.util.Map parameters)

call

public java.lang.Object call(Entity entity)
Convenience for named-parameter syntax (needs map in first argument)

call

public java.lang.Object call(@SuppressWarnings("rawtypes") java.util.Map parameters, Entity entity)
Convenience for named-parameter syntax (needs map in first argument)

getBody

@Override
public final EffectorTaskFactory getBody()
not meant for overriding; subclasses should override the abstract call(Entity, Map) method in this class

getFlagsForTaskInvocationAt

protected java.util.Map getFlagsForTaskInvocationAt(Entity entity)
subclasses may override to add additional flags, but they should include the flags returned here unless there is very good reason not to

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.