Method Detail

• getId

  java.lang.String getId()

  A unique id for this location.

  Specified by:

  getId in interface Identifiable

• getDisplayName

  java.lang.String getDisplayName()

  Get the name assigned to this location.

  Specified by:

  getDisplayName in interface BrooklynObject

  Returns:

  the name assigned to the location.

  Since:

  0.6 (previously getName())

• getParent

  Location getParent()

  Get the 'parent' of this location. Locations are organized into a tree hierarchy, and this method will return a reference to the parent of this location, or null if this location is the tree root.

  Returns:

  a reference to the parent of this location, or null if this location is the tree root.

  Since:

  0.6 (previously getParentLocation())

• getChildren

  java.util.Collection<Location> getChildren()

  Get the 'children' of this location. Locations are organized into a tree hierarchy, and this method will return a collection containing the children of this location. This collection is an unmodifiable view of the data.

  Returns:

  a collection containing the children of this location.

  Since:

  0.6 (previously getChildLocations())

• setParent

  void setParent(Location newParent)

  Set the 'parent' of this location. If this location was previously a child of a different location, it is removed from the other location first. It is valid to pass in null to indicate that the location should be disconnected from its parent. Adds this location as a child of the new parent (see getChildLocations()).

  Parameters:

  newParent - the new parent location object, or null to clear the parent reference.

  Since:

  0.6 (previously setParentLocation(Location))

• toVerboseString

  java.lang.String toVerboseString()

  Returns:

  meta-data about the location (usually a long line, or a small number of lines).

  Since:

  0.6

• containsLocation

  boolean containsLocation(Location potentialDescendent)

  Answers true if this location equals or is an ancestor of the given location.

• getConfig

  <T> T getConfig(ConfigKey<T> key)

  Returns configuration set at this location or inherited or default

• getConfig

  <T> T getConfig(ConfigKey.HasConfigKey<T> key)

• hasConfig

  boolean hasConfig(ConfigKey<?> key,
                  boolean includeInherited)

  True iff the indication config key is set, either inherited (second argument true) or locally-only (second argument false)

• getAllConfig

  java.util.Map<java.lang.String,java.lang.Object> getAllConfig(boolean includeInherited)

  Returns all config set, either inherited (argument true) or locally-only (argument false)

• hasExtension

  boolean hasExtension(java.lang.Class<?> extensionType)

  Whether this location has support for the given extension type. See additional comments in getExtension(Class).

  Throws:

  java.lang.NullPointerException - if extensionType is null

• getExtension

  <T> T getExtension(java.lang.Class<T> extensionType)

  Returns an extension of the given type. Note that the type must be an exact match for how the extension was registered (e.g. getExtension(Object.class) will not match anything, even though registered extension extend Object.

  This will not look at extensions of getParent().

  Throws:

  java.lang.IllegalArgumentException - if this location does not support the given extension type

  java.lang.NullPointerException - if extensionType is null