brooklyn.entity
Interface Effector<T>

All Superinterfaces:

Serializable

public interface Effector<T>
extends Serializable

An operation of some kind, carried out by an Entity. Similar to the concepts in the JMX MBeanOperationInfo class.

Method Summary

String	getDescription() optional description for the effector
String	getName() human-friendly name of the effector (although frequently this uses java method naming convention)
List<ParameterType<?>>	getParameters() parameters expected by method, including name and type, optional description and default value
Class<T>	getReturnType()
String	getReturnTypeName() canonical name of return type (in case return type does not resolve after serialization)

Method Detail

getName

String getName()

human-friendly name of the effector (although frequently this uses java method naming convention)

getReturnType

Class<T> getReturnType()

getReturnTypeName

String getReturnTypeName()

canonical name of return type (in case return type does not resolve after serialization)

getParameters

List<ParameterType<?>> getParameters()

parameters expected by method, including name and type, optional description and default value

getDescription

String getDescription()

optional description for the effector