Group (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.entity
[Java] Interface Group

brooklyn.entity.Entity
  brooklyn.entity.Group
      brooklyn.entity.rebind.Rebindable

All Superinterfaces:: Entity, Rebindable

public interface Group
extends Entity

An Entity that groups together other entities. The grouping can be for any purpose, such as allowing easy management/monitoring of a group of entities. The grouping could be static (i.e. a fixed set of entities) or dynamic (i.e. contains all entities that match some filter).

Method Summary
`boolean`	`addMember(Entity member)` Adds the given member, returning true if this modifies the set of members (i.e. it was not already a member).
`java.lang.Integer`	`getCurrentSize()` @return The number of members in this group.
`java.util.Collection`	`getMembers()` Return the entities that are members of this group.
`boolean`	`hasMember(Entity member)` @return True if it is a member of this group.
`boolean`	`removeMember(Entity member)` Removes the given member, returning true if this modifies the set of members (i.e. it was a member).

Methods inherited from interface Entity
addChild, addChild, addEnricher, addGroup, addOwnedChild, addPolicy, clearOwner, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getDisplayName, getEnrichers, getEntityType, getGroups, getId, getLocations, getOwnedChildren, getOwner, getParent, getPolicies, getRebindSupport, invoke, removeChild, removeEnricher, removeOwnedChild, removePolicy, setOwner, setParent

Methods inherited from interface Entity

addChild, addChild, addEnricher, addGroup, addOwnedChild, addPolicy, clearOwner, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getDisplayName, getEnrichers, getEntityType, getGroups, getId, getLocations, getOwnedChildren, getOwner, getParent, getPolicies, getRebindSupport, invoke, removeChild, removeEnricher, removeOwnedChild, removePolicy, setOwner, setParent

Methods inherited from interface Rebindable
getRebindSupport

Method Detail

addMember

public boolean addMember(Entity member)

Adds the given member, returning true if this modifies the set of members (i.e. it was not already a member).

getCurrentSize

public java.lang.Integer getCurrentSize()

Returns:: The number of members in this group.

getMembers

public java.util.Collection getMembers()

Return the entities that are members of this group.

hasMember

public boolean hasMember(Entity member)

Returns:: True if it is a member of this group.

removeMember

public boolean removeMember(Entity member)

Removes the given member, returning true if this modifies the set of members (i.e. it was a member).