EntitySpec (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.api.internal.AbstractBrooklynObjectSpec<T,EntitySpec<T>>
- - org.apache.brooklyn.api.entity.EntitySpec<T>

Type Parameters:
T - The type of entity to be created

All Implemented Interfaces:

java.io.Serializable
```
public class EntitySpec<T extends Entity>
extends AbstractBrooklynObjectSpec<T,EntitySpec<T>>
```
Gives details of an entity to be created. It describes the entity's configuration, and is reusable to create multiple entities with the same configuration. To create an EntitySpec, it is strongly encouraged to use create(Class) etc. Users who need to implement this are strongly encouraged to extend EntitySpec.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

EntitySpec(java.lang.Class<T> type)

Constructors
Constructor and Description
`EntitySpec(java.lang.Class<T> type)`

Method Summary

Methods
Modifier and Type	Method and Description
`EntitySpec<T>`	`addInitializer(java.lang.Class<? extends EntityInitializer> initializerType)` The supplied class must have a public no-arg constructor.
`EntitySpec<T>`	`addInitializer(EntityInitializer initializer)`
`EntitySpec<T>`	`addInitializers(java.lang.Iterable<? extends EntityInitializer> initializers)`
`EntitySpec<T>`	`additionalInterfaces(java.lang.Class<?>... vals)`
`EntitySpec<T>`	`additionalInterfaces(java.lang.Iterable<java.lang.Class<?>> val)`
`EntitySpec<T>`	`child(EntitySpec<?> child)` The supplied class must have a public no-arg constructor.
`EntitySpec<T>`	`children(java.lang.Iterable<? extends EntitySpec<?>> children)`
`void`	`clearConfig()` Clears the config map, removing any config previously set.
`EntitySpec<T>`	`configure(java.lang.CharSequence key, java.lang.Object val)`
`<V> EntitySpec<T>`	`configure(ConfigKey.HasConfigKey<V> key, Task<? extends V> val)`
`<V> EntitySpec<T>`	`configure(ConfigKey.HasConfigKey<V> key, V val)`
`<V> EntitySpec<T>`	`configure(ConfigKey<V> key, com.google.common.base.Supplier<? extends V> val)`
`<V> EntitySpec<T>`	`configure(ConfigKey<V> key, Task<? extends V> val)`
`<V> EntitySpec<T>`	`configure(ConfigKey<V> key, V val)`
`EntitySpec<T>`	`configure(java.util.Map<?,?> val)` strings inserted as flags, config keys inserted as config keys; if you want to force one or the other, create a ConfigBag and convert to the appropriate map type
`static <T extends Entity> EntitySpec<T>`	`create(java.lang.Class<T> type)` Creates a new `EntitySpec` instance for an entity of the given type.
`static <T extends Entity,U extends T> EntitySpec<T>`	`create(java.lang.Class<T> type, java.lang.Class<U> implType)` Creates a new `EntitySpec` instance for an entity of the given type.
`static <T extends Entity> EntitySpec<T>`	`create(EntitySpec<T> spec)` Copies entity spec so its configuration can be overridden without modifying the original entity spec.
`static <T extends Entity> EntitySpec<T>`	`create(java.util.Map<?,?> config, java.lang.Class<T> type)` Creates a new `EntitySpec` instance with the given config, for an entity of the given type.
`<V> EntitySpec<T>`	`enricher(Enricher val)` adds a policy to the spec
`<V> EntitySpec<T>`	`enricher(EnricherSpec<?> val)` adds a policy to the spec
`<V> EntitySpec<T>`	`enrichers(java.lang.Iterable<? extends Enricher> val)` adds the supplied policies to the spec
`<V> EntitySpec<T>`	`enricherSpecs(java.lang.Iterable<? extends EnricherSpec<?>> val)` adds the supplied policies to the spec
`java.util.Set<java.lang.Class<?>>`	`getAdditionalInterfaces()`
`java.util.List<EntitySpec<?>>`	`getChildren()`
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getConfig()`
`java.util.List<Enricher>`	`getEnrichers()`
`java.util.List<EnricherSpec<?>>`	`getEnricherSpecs()`
`java.util.Map<java.lang.String,?>`	`getFlags()`
`java.util.List<Group>`	`getGroups()`
`java.lang.Class<? extends T>`	`getImplementation()`
`java.util.List<EntityInitializer>`	`getInitializers()`
`java.util.List<Location>`	`getLocations()`
`java.util.List<Entity>`	`getMembers()`
`Entity`	`getParent()`
`java.util.List<Policy>`	`getPolicies()`
`java.util.List<PolicySpec<?>>`	`getPolicySpecs()`
`java.lang.Class<T>`	`getType()`
`EntitySpec<T>`	`group(Group group)`
`EntitySpec<T>`	`groups(java.lang.Iterable<? extends Group> groups)`
`EntitySpec<T>`	`immutable()` "seals" this spec, preventing any future changes
`EntitySpec<T>`	`impl(java.lang.Class<? extends T> val)`
`<V> EntitySpec<T>`	`location(Location val)` adds a location to the spec
`<V> EntitySpec<T>`	`locations(java.lang.Iterable<? extends Location> val)` adds the supplied locations to the spec
`EntitySpec<T>`	`member(Entity member)`
`EntitySpec<T>`	`members(java.lang.Iterable<? extends Entity> members)`
`static <T extends Entity> EntitySpec<T>`	`newInstance(java.lang.Class<T> type)`
`EntitySpec<T>`	`parent(Entity val)`
`<V> EntitySpec<T>`	`policies(java.lang.Iterable<? extends Policy> val)` adds the supplied policies to the spec
`<V> EntitySpec<T>`	`policy(Policy val)` adds a policy to the spec
`<V> EntitySpec<T>`	`policy(PolicySpec<?> val)` adds a policy to the spec
`<V> EntitySpec<T>`	`policySpecs(java.lang.Iterable<? extends PolicySpec<?>> val)` adds the supplied policies to the spec

Methods inherited from class org.apache.brooklyn.api.internal.AbstractBrooklynObjectSpec
catalogItemId, displayName, equals, getCatalogItemId, getDisplayName, getTags, hashCode, tag, tags, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EntitySpec

public EntitySpec(java.lang.Class<T> type)

Method Detail

create
```
public static <T extends Entity> EntitySpec<T> create(java.lang.Class<T> type)
```
Creates a new EntitySpec instance for an entity of the given type. The returned EntitySpec can then be customized.

Parameters:
type - An Entity interface

create
```
public static <T extends Entity,U extends T> EntitySpec<T> create(java.lang.Class<T> type,
                                                  java.lang.Class<U> implType)
```
Creates a new EntitySpec instance for an entity of the given type. The returned EntitySpec can then be customized.

Parameters:
type - An Entity interface
implType - An Entity implementation, which implements the type interface

create
```
public static <T extends Entity> EntitySpec<T> create(java.util.Map<?,?> config,
                                      java.lang.Class<T> type)
```
Creates a new EntitySpec instance with the given config, for an entity of the given type. This is primarily for groovy code; equivalent to EntitySpec.create(type).configure(config).

Parameters:
config - The spec's configuration (see configure(Map)).
type - An Entity interface

create
```
public static <T extends Entity> EntitySpec<T> create(EntitySpec<T> spec)
```
Copies entity spec so its configuration can be overridden without modifying the original entity spec.

newInstance

public static <T extends Entity> EntitySpec<T> newInstance(java.lang.Class<T> type)

getType
```
public java.lang.Class<T> getType()
```
Overrides:

getType in class AbstractBrooklynObjectSpec<T extends Entity,EntitySpec<T extends Entity>>

Returns:
The type of the object (or significant interface)

getImplementation
```
@Nullable
public java.lang.Class<? extends T> getImplementation()
```
Returns:
The implementation of the entity; if not null. this overrides any defaults or other configuration
See Also:
on the entity interface classes for how defaults are defined., for how implementations can be defined globally

getAdditionalInterfaces
```
public java.util.Set<java.lang.Class<?>> getAdditionalInterfaces()
```
Returns:
Additional interfaces (other than just getType()) that this entity implements; important for when accessing entity through a proxy to determine which interfaces the proxy exposes.

getInitializers
```
public java.util.List<EntityInitializer> getInitializers()
```
Returns:
EntityInitializer objects which customize the entity to be created

getChildren

public java.util.List<EntitySpec<?>> getChildren()

getMembers

public java.util.List<Entity> getMembers()

getGroups

public java.util.List<Group> getGroups()

getParent
```
public Entity getParent()
```
Returns:
The entity's parent

getFlags
```
public java.util.Map<java.lang.String,?> getFlags()
```
Returns:
Read-only construction flags
See Also:
declarations on the entity type

getConfig

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

Returns:: Read-only configuration values

clearConfig
```
public void clearConfig()
```
Clears the config map, removing any config previously set.

getPolicySpecs

public java.util.List<PolicySpec<?>> getPolicySpecs()

getPolicies

public java.util.List<Policy> getPolicies()

getEnricherSpecs

public java.util.List<EnricherSpec<?>> getEnricherSpecs()

getEnrichers

public java.util.List<Enricher> getEnrichers()

getLocations

public java.util.List<Location> getLocations()

impl

public EntitySpec<T> impl(java.lang.Class<? extends T> val)

additionalInterfaces

public EntitySpec<T> additionalInterfaces(java.lang.Class<?>... vals)

additionalInterfaces

public EntitySpec<T> additionalInterfaces(java.lang.Iterable<java.lang.Class<?>> val)

addInitializer

public EntitySpec<T> addInitializer(EntityInitializer initializer)

addInitializers

public EntitySpec<T> addInitializers(java.lang.Iterable<? extends EntityInitializer> initializers)

addInitializer

public EntitySpec<T> addInitializer(java.lang.Class<? extends EntityInitializer> initializerType)

The supplied class must have a public no-arg constructor.

children

public EntitySpec<T> children(java.lang.Iterable<? extends EntitySpec<?>> children)

child
```
public EntitySpec<T> child(EntitySpec<?> child)
```
The supplied class must have a public no-arg constructor.

members

public EntitySpec<T> members(java.lang.Iterable<? extends Entity> members)

member

public EntitySpec<T> member(Entity member)

groups

public EntitySpec<T> groups(java.lang.Iterable<? extends Group> groups)

group

public EntitySpec<T> group(Group group)

parent

public EntitySpec<T> parent(Entity val)

configure
```
public EntitySpec<T> configure(java.util.Map<?,?> val)
```
strings inserted as flags, config keys inserted as config keys; if you want to force one or the other, create a ConfigBag and convert to the appropriate map type

configure

public EntitySpec<T> configure(java.lang.CharSequence key,
                      java.lang.Object val)

configure

public <V> EntitySpec<T> configure(ConfigKey<V> key,
                          V val)

configure

public <V> EntitySpec<T> configure(ConfigKey<V> key,
                          Task<? extends V> val)

configure

public <V> EntitySpec<T> configure(ConfigKey<V> key,
                          com.google.common.base.Supplier<? extends V> val)

configure

public <V> EntitySpec<T> configure(ConfigKey.HasConfigKey<V> key,
                          V val)

configure

public <V> EntitySpec<T> configure(ConfigKey.HasConfigKey<V> key,
                          Task<? extends V> val)

policy

public <V> EntitySpec<T> policy(Policy val)

adds a policy to the spec

policy

public <V> EntitySpec<T> policy(PolicySpec<?> val)

adds a policy to the spec

policySpecs

public <V> EntitySpec<T> policySpecs(java.lang.Iterable<? extends PolicySpec<?>> val)

adds the supplied policies to the spec

policies

public <V> EntitySpec<T> policies(java.lang.Iterable<? extends Policy> val)

adds the supplied policies to the spec

enricher

public <V> EntitySpec<T> enricher(Enricher val)

adds a policy to the spec

enricher

public <V> EntitySpec<T> enricher(EnricherSpec<?> val)

adds a policy to the spec

enricherSpecs

public <V> EntitySpec<T> enricherSpecs(java.lang.Iterable<? extends EnricherSpec<?>> val)

adds the supplied policies to the spec

enrichers

public <V> EntitySpec<T> enrichers(java.lang.Iterable<? extends Enricher> val)

adds the supplied policies to the spec

location

public <V> EntitySpec<T> location(Location val)

adds a location to the spec

locations

public <V> EntitySpec<T> locations(java.lang.Iterable<? extends Location> val)

adds the supplied locations to the spec

immutable
```
public EntitySpec<T> immutable()
```
"seals" this spec, preventing any future changes

Class EntitySpec<T extends Entity>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

EntitySpec

Method Detail

create

create

create

create

newInstance

getType

getImplementation

getAdditionalInterfaces

getInitializers

getChildren

getMembers

getGroups

getParent

getFlags

getConfig

clearConfig

getPolicySpecs

getPolicies

getEnricherSpecs

getEnrichers

getLocations

impl

additionalInterfaces

additionalInterfaces

addInitializer

addInitializers

addInitializer

children

child

members

member

groups

group

parent

configure

configure

configure

configure

configure

configure

configure

policy

policy

policySpecs

policies

enricher

enricher

enricherSpecs

enrichers

location

locations

immutable