EffectorTasks (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

brooklyn.entity.effector
[Java] Class EffectorTasks

java.lang.Object
  brooklyn.entity.effector.EffectorTasks

@Beta
public class EffectorTasks

Nested Class Summary
`static class`	`EffectorTasks.EffectorBodyTaskFactory`
`interface`	`EffectorTasks.EffectorTaskFactory`
`static class`	`EffectorTasks.ParameterTask`

Method Summary
`static ConfigKey`	`asConfigKey(ParameterType t)`
`static Entity`	`findEntity()` Finds the entity where this task is running
`static java.lang.Object`	`findEntity(java.lang.Class type)` Finds the entity where this task is running, casted to the given Entity subtype
`static SshMachineLocation`	`findSshMachine()` Finds a unique SshMachineLocation attached to the entity where this task is running
`static SshMachineLocation`	`getSshMachine(Entity entity)` Finds a unique SshMachineLocation attached to the supplied entity
`static EffectorTasks.EffectorTaskFactory`	`of(Task task)`
`static EffectorTasks.ParameterTask`	`parameter(ParameterType t)`
`static EffectorTasks.ParameterTask`	`parameter(java.lang.Class type, java.lang.String name)`
`static EffectorTasks.ParameterTask`	`parameter(ConfigKey p)`

Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()

Method Detail

public static ConfigKey asConfigKey(ParameterType t)

public static Entity findEntity()

Finds the entity where this task is running

throws:: NullPointerException if there is none (no task, or no context entity for that task)

public static java.lang.Object findEntity(java.lang.Class type)

Finds the entity where this task is running, casted to the given Entity subtype

public static SshMachineLocation findSshMachine()

Finds a unique SshMachineLocation attached to the entity where this task is running

public static SshMachineLocation getSshMachine(Entity entity)

Finds a unique SshMachineLocation attached to the supplied entity

throws:: IllegalStateException if there is not a unique such SshMachineLocation

public static EffectorTasks.EffectorTaskFactory of(Task task)

public static EffectorTasks.ParameterTask parameter(ParameterType t)

public static EffectorTasks.ParameterTask parameter(java.lang.Class type, java.lang.String name)

public static EffectorTasks.ParameterTask parameter(ConfigKey p)