org.apache.brooklyn.api.location

Class LocationSpec<T extends Location>

java.lang.Object

org.apache.brooklyn.api.internal.AbstractBrooklynObjectSpec<T,LocationSpec<T>>

org.apache.brooklyn.api.location.LocationSpec<T>

Type Parameters:

T - The type of location to be created

All Implemented Interfaces:

java.io.Serializable

public class LocationSpec<T extends Location>
extends AbstractBrooklynObjectSpec<T,LocationSpec<T>>

Gives details of a location to be created. It describes the location's configuration, and is reusable to create multiple locations with the same configuration. To create a LocationSpec, it is strongly encouraged to use create(...) methods.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static <T extends Location> LocationSpec<T>	create(java.lang.Class<T> type) Creates a new LocationSpec instance for a location of the given type.
static <T extends Location> LocationSpec<T>	create(LocationSpec<T> spec) Copies entity spec so its configuration can be overridden without modifying the original entity spec.
static <T extends Location> LocationSpec<T>	create(java.util.Map<?,?> config, java.lang.Class<T> type) Creates a new LocationSpec instance with the given config, for a location of the given type.
<E> LocationSpec<T>	extension(java.lang.Class<E> extensionType, E extension)
<E> LocationSpec<T>	extensions(java.util.Map<java.lang.Class<?>,?> extensions)
java.util.Map<ConfigKey<?>,java.lang.Object>	getConfig()
java.util.Map<java.lang.Class<?>,java.lang.Object>	getExtensions()
java.util.Map<java.lang.String,?>	getFlags()
Location	getParent()
LocationSpec<T>	parent(Location val)

Methods inherited from class org.apache.brooklyn.api.internal.AbstractBrooklynObjectSpec

addSearchPath, catalogItemId, catalogItemIdAndSearchPath, catalogItemIdIfNotNull, clearConfig, configure, configure, configure, configure, configure, configure, configureIfNotNull, displayName, equals, getCatalogItemId, getCatalogItemIdSearchPath, getDisplayName, getParameters, getTags, getType, hashCode, parameters, parametersAdd, parametersReplace, removeConfig, removeFlag, stackCatalogItemId, tag, tags, tagsAdd, tagsReplace, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <T extends Location> LocationSpec<T> create(java.lang.Class<T> type)

Creates a new LocationSpec instance for a location of the given type. The returned LocationSpec can then be customized.

Parameters:

type - A Location class

create

public static <T extends Location> LocationSpec<T> create(java.util.Map<?,?> config,
                                                          java.lang.Class<T> type)

Creates a new LocationSpec instance with the given config, for a location of the given type. This is primarily for groovy code; equivalent to LocationSpec.create(type).configure(config).

Parameters:

config - The spec's configuration (see AbstractBrooklynObjectSpec.configure(Map)).

type - A Location class

create

public static <T extends Location> LocationSpec<T> create(LocationSpec<T> spec)

Copies entity spec so its configuration can be overridden without modifying the original entity spec.

parent

public LocationSpec<T> parent(Location val)

extension

public <E> LocationSpec<T> extension(java.lang.Class<E> extensionType,
                                     E extension)

extensions

public <E> LocationSpec<T> extensions(java.util.Map<java.lang.Class<?>,?> extensions)

getParent

public Location getParent()

Returns:

The location's parent

getFlags

public java.util.Map<java.lang.String,?> getFlags()

Overrides:

getFlags in class AbstractBrooklynObjectSpec<T extends Location,LocationSpec<T extends Location>>

Returns:

Read-only construction flags

See Also:

declarations on the location type

getConfig

public java.util.Map<ConfigKey<?>,java.lang.Object> getConfig()

Overrides:

getConfig in class AbstractBrooklynObjectSpec<T extends Location,LocationSpec<T extends Location>>

Returns:

Read-only configuration values

getExtensions

public java.util.Map<java.lang.Class<?>,java.lang.Object> getExtensions()

Returns:

Read-only extension values