Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.policy
[Java] Class EnricherSpec

java.lang.Object
  brooklyn.policy.EnricherSpec
All Implemented Interfaces:
java.io.Serializable
public class EnricherSpec

Gives details of an enricher to be created. It describes the enricher's configuration, and is reusable to create multiple enrichers with the same configuration. To create an EnricherSpec, it is strongly encouraged to use create(...) methods.

Parameters:
- The type of enricher to be created
Authors:
aled

Constructor Summary
protected EnricherSpec(java.lang.Class type)

 
Method Summary
EnricherSpec configure(java.util.Map val)

EnricherSpec configure(java.lang.CharSequence key, java.lang.Object val)

EnricherSpec configure(ConfigKey key, java.lang.Object val)

EnricherSpec configure(ConfigKey key, Task val)

EnricherSpec configure(HasConfigKey key, java.lang.Object val)

EnricherSpec configure(HasConfigKey key, Task val)

EnricherSpec configureIfNotNull(ConfigKey key, java.lang.Object val)

static EnricherSpec create(java.lang.Class type)

Creates a new EnricherSpec instance for an enricher of the given type.

static EnricherSpec create(java.util.Map config, java.lang.Class type)

Creates a new EnricherSpec instance with the given config, for an enricher of the given type.
EnricherSpec displayName(java.lang.String val)

java.util.Map getConfig()

@return Read-only configuration values
java.lang.String getDisplayName()

@return The display name of the enricher
java.util.Map getFlags()

@return Read-only construction flags
java.lang.Class getType()

@return The type of the enricher
java.lang.String toString()

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Constructor Detail

EnricherSpec

protected EnricherSpec(java.lang.Class type)

 
Method Detail

configure

public EnricherSpec configure(java.util.Map val)

configure

public EnricherSpec configure(java.lang.CharSequence key, java.lang.Object val)

configure

public EnricherSpec configure(ConfigKey key, java.lang.Object val)

configure

public EnricherSpec configure(ConfigKey key, Task val)

configure

public EnricherSpec configure(HasConfigKey key, java.lang.Object val)

configure

public EnricherSpec configure(HasConfigKey key, Task val)

configureIfNotNull

public EnricherSpec configureIfNotNull(ConfigKey key, java.lang.Object val)

create

public static EnricherSpec create(java.lang.Class type)
Creates a new EnricherSpec instance for an enricher of the given type. The returned EnricherSpec can then be customized.
Parameters:
type - A Enricher class

create

public static EnricherSpec create(java.util.Map config, java.lang.Class type)
Creates a new EnricherSpec instance with the given config, for an enricher of the given type. This is primarily for groovy code; equivalent to EnricherSpec.create(type).configure(config).
Parameters:
config - The spec's configuration (see EnricherSpec#configure(Map)#configure(Map)).
type - An Enricher class

displayName

public EnricherSpec displayName(java.lang.String val)

getConfig

public java.util.Map getConfig()
Returns:
Read-only configuration values

getDisplayName

public java.lang.String getDisplayName()
Returns:
The display name of the enricher

getFlags

public java.util.Map getFlags()
Returns:
Read-only construction flags
See Also:
SetFromFlag

getType

public java.lang.Class getType()
Returns:
The type of the enricher

toString

@Override
public java.lang.String toString()

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.