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

brooklyn.entity.basic
[Java] Class Entities

java.lang.Object
  brooklyn.entity.basic.Entities

public class Entities

Convenience methods for working with entities. Also see the various *Methods classes for traits (eg StartableMethods for Startable implementations).

Method Summary
static void destroy(ManagementContext context, Entity e)

Interim method for assisting with entity lifecycle
static void dumpInfo(Entity e)

static void dumpInfo(Entity e, java.io.Writer out)

static void dumpInfo(Entity e, java.lang.String currentIndentation, java.lang.String tab)

static void dumpInfo(Entity e, java.io.Writer out, java.lang.String currentIndentation, java.lang.String tab)

static Task invokeEffectorList(EntityLocal callingEntity, java.lang.Iterable entitiesToCall, Effector effector, java.util.Map parameters)

invokes the given effector with the given named arguments on the entitiesToCall, from the calling context of the callingEntity; intended for use only from the callingEntity
static Task invokeEffectorList(EntityLocal callingEntity, java.lang.Iterable entitiesToCall, Effector effector)

static void invokeStopOnShutdown(Entity entity)

static boolean isAncestor(Entity descendant, Entity potentialAncestor)

static boolean isDescendant(Entity ancestor, Entity potentialDescendant)

note, it is usually preferred to use isAncestor() and swap the order, it is a cheaper method
static boolean isSecret(java.lang.String name)

static boolean isTrivial(java.lang.Object v)

static java.util.Map sanitize(java.util.Map input)

static java.util.List sortConfigKeys(java.util.Set configs)

static java.util.List sortSensors(java.util.Set sensors)

static Entity start(ManagementContext context, Entity e, java.util.Collection locations)

Interim method for assisting with entity lifecycle
 
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

destroy

public static void destroy(ManagementContext context, Entity e)
Interim method for assisting with entity lifecycle

dumpInfo

public static void dumpInfo(Entity e)

dumpInfo

public static void dumpInfo(Entity e, java.io.Writer out)

dumpInfo

public static void dumpInfo(Entity e, java.lang.String currentIndentation, java.lang.String tab)

dumpInfo

public static void dumpInfo(Entity e, java.io.Writer out, java.lang.String currentIndentation, java.lang.String tab)

invokeEffectorList

public static Task invokeEffectorList(EntityLocal callingEntity, java.lang.Iterable entitiesToCall, Effector effector, java.util.Map parameters)
invokes the given effector with the given named arguments on the entitiesToCall, from the calling context of the callingEntity; intended for use only from the callingEntity
Returns:
ParallelTask containing a results from each invocation; calling get() on the result will block until all complete, and throw error if any threw error

invokeEffectorList

public static Task invokeEffectorList(EntityLocal callingEntity, java.lang.Iterable entitiesToCall, Effector effector)

invokeStopOnShutdown

public static void invokeStopOnShutdown(Entity entity)

isAncestor

public static boolean isAncestor(Entity descendant, Entity potentialAncestor)

isDescendant

public static boolean isDescendant(Entity ancestor, Entity potentialDescendant)
note, it is usually preferred to use isAncestor() and swap the order, it is a cheaper method

isSecret

public static boolean isSecret(java.lang.String name)

isTrivial

public static boolean isTrivial(java.lang.Object v)

sanitize

public static java.util.Map sanitize(java.util.Map input)

sortConfigKeys

@SuppressWarnings({ "rawtypes", "unchecked" })
public static java.util.List sortConfigKeys(java.util.Set configs)

sortSensors

ssWarnings({ "rawtypes", "unchecked" })
public static java.util.List sortSensors(java.util.Set sensors)

start

public static Entity start(ManagementContext context, Entity e, java.util.Collection locations)
Interim method for assisting with entity lifecycle

 

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