org.apache.brooklyn.api.sensor

Class EnricherSpec<T extends Enricher>

java.lang.Object

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

org.apache.brooklyn.api.sensor.EnricherSpec<T>

Type Parameters:

T - The type of enricher to be created

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EnricherSpec.ExtensibleEnricherSpec

public class EnricherSpec<T extends Enricher>
extends AbstractBrooklynObjectSpec<T,EnricherSpec<T>>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnricherSpec.ExtensibleEnricherSpec<T extends Enricher,K extends EnricherSpec.ExtensibleEnricherSpec<T,K>>

Method Summary

Modifier and Type	Method and Description
static <T extends Enricher> EnricherSpec<T>	create(java.lang.Class<? extends T> type) Creates a new EnricherSpec instance for an enricher of the given type.
static <T extends Enricher> EnricherSpec<T>	create(java.util.Map<?,?> config, java.lang.Class<T> type) Creates a new EnricherSpec instance with the given config, for an enricher of the given type.
EnricherSpec<T>	uniqueTag(java.lang.String uniqueTag)

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, getConfig, getDisplayName, getFlags, 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 Enricher> EnricherSpec<T> create(java.lang.Class<? extends T> 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 <T extends Enricher> EnricherSpec<T> create(java.util.Map<?,?> config,
                                                          java.lang.Class<T> 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 AbstractBrooklynObjectSpec.configure(Map)).

type - An Enricher class

uniqueTag

public EnricherSpec<T> uniqueTag(java.lang.String uniqueTag)