EffectorBase (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.effector.EffectorBase<T>

All Implemented Interfaces:

Effector<T>, java.io.Serializable

Direct Known Subclasses:

AbstractEffector, EffectorAndBody
```
public class EffectorBase<T>
extends java.lang.Object
implements Effector<T>
```
concrete implementation of Effector interface, but not (at this level of the hirarchy) defining an implementation (see EffectorTasks.EffectorTaskFactory and EffectorWithBody)

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`EffectorBase(java.lang.String name, java.lang.Class<T> returnType, java.util.List<ParameterType<?>> parameters, java.lang.String description)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`java.lang.String`	`getDescription()` optional description for the effector
`java.lang.String`	`getName()` human-friendly name of the effector (although frequently this uses java method naming convention)
`java.util.List<ParameterType<?>>`	`getParameters()` parameters expected by method, including name and type, optional description and default value
`java.lang.Class<T>`	`getReturnType()`
`java.lang.String`	`getReturnTypeName()` canonical name of return type (in case return type does not resolve after serialization)
`int`	`hashCode()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - EffectorBase
```
public EffectorBase(java.lang.String name,
            java.lang.Class<T> returnType,
            java.util.List<ParameterType<?>> parameters,
            java.lang.String description)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Effector
    
    human-friendly name of the effector (although frequently this uses java method naming convention)
    
    Specified by:
    
    getName in interface Effector<T>
  - getReturnType
```
public java.lang.Class<T> getReturnType()
```
    Specified by:
    
    getReturnType in interface Effector<T>
  - getReturnTypeName
```
public java.lang.String getReturnTypeName()
```
    Description copied from interface: Effector
    
    canonical name of return type (in case return type does not resolve after serialization)
    
    Specified by:
    
    getReturnTypeName in interface Effector<T>
  - getParameters
```
public java.util.List<ParameterType<?>> getParameters()
```
    Description copied from interface: Effector
    
    parameters expected by method, including name and type, optional description and default value
    
    Specified by:
    
    getParameters in interface Effector<T>
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Effector
    
    optional description for the effector
    
    Specified by:
    
    getDescription in interface Effector<T>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object

Class EffectorBase<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EffectorBase

Method Detail

getName

getReturnType

getReturnTypeName

getParameters

getDescription

toString

hashCode

equals