EntitySpec (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.entity.proxying
[Java] Interface EntitySpec

public interface EntitySpec

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 EntitySpecs. Users who need to implement this are strongly encouraged to extend BasicEntitySpec.

Parameters:: - The type of entity to be created

Authors:: aled

Method Summary
`java.util.Set`	`getAdditionalInterfaces()`
`java.util.Map`	`getConfig()` @return Read-only configuration values
`java.lang.String`	`getDisplayName()` @return The display name of the entity
`java.util.Map`	`getFlags()` @return Read-only construction flags
`java.lang.Class`	`getImplementation()` @return The implementation of the entity; if not null. this overrides any defaults or other configuration
`Entity`	`getParent()` @return The entity's parent
`java.util.List`	`getPolicies()`
`java.lang.Class`	`getType()` @return The type of the entity

Method Detail

getAdditionalInterfaces

public java.util.Set getAdditionalInterfaces()

getConfig

public java.util.Map getConfig()

Returns:: Read-only configuration values

getDisplayName

public java.lang.String getDisplayName()

Returns:: The display name of the entity

getFlags

public java.util.Map getFlags()

Returns:: Read-only construction flags

See Also:: SetFromFlag

getImplementation

@Nullable
public java.lang.Class getImplementation()

Returns:: The implementation of the entity; if not null. this overrides any defaults or other configuration

See Also:: ImplementedBy; EntityTypeRegistry

getParent

public Entity getParent()

Returns:: The entity's parent

getPolicies

public java.util.List getPolicies()

getType

public java.lang.Class getType()

Returns:: The type of the entity

brooklyn.entity.proxying [Java] Interface EntitySpec