org.apache.brooklyn.api.policy

Class PolicySpec<T extends Policy>

java.lang.Object

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

org.apache.brooklyn.api.policy.PolicySpec<T>

Type Parameters:

T - The type of policy to be created

All Implemented Interfaces:

java.io.Serializable

public class PolicySpec<T extends Policy>
extends AbstractBrooklynObjectSpec<T,PolicySpec<T>>

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static <T extends Policy> PolicySpec<T>	create(java.lang.Class<T> type) Creates a new PolicySpec instance for a policy of the given type.
static <T extends Policy> PolicySpec<T>	create(java.util.Map<?,?> config, java.lang.Class<T> type) Creates a new PolicySpec instance with the given config, for a policy of the given type.
PolicySpec<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 Policy> PolicySpec<T> create(java.lang.Class<T> type)

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

Parameters:

type - A Policy class

create

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

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

Parameters:

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

type - A Policy class

uniqueTag

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