public abstract class AbstractBrooklynObjectSpec<T,SpecT extends AbstractBrooklynObjectSpec<T,SpecT>>
extends java.lang.Object
implements java.io.Serializable
BrooklynObject.
In addition to the contract defined by the code,
subclasses should provide a public static create(Class)
method to create an instance of the spec for the target type indicated by the argument.
The spec is then passed to type-specific methods,
e.g. EntityManager.createEntity(org.apache.brooklyn.api.entity.EntitySpec)
to create a managed instance of the target type.
| Modifier and Type | Method and Description |
|---|---|
SpecT |
catalogItemId(java.lang.String val) |
SpecT |
catalogItemIdIfNotNull(java.lang.String val) |
void |
clearConfig()
Clears the config map, removing any config previously set.
|
SpecT |
configure(java.lang.CharSequence key,
java.lang.Object val) |
<V> SpecT |
configure(ConfigKey.HasConfigKey<V> key,
Task<? extends V> val) |
<V> SpecT |
configure(ConfigKey.HasConfigKey<V> key,
V val) |
<V> SpecT |
configure(ConfigKey<V> key,
Task<? extends V> val) |
<V> SpecT |
configure(ConfigKey<V> key,
V val) |
SpecT |
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
|
<V> SpecT |
configureIfNotNull(ConfigKey<V> key,
V val) |
SpecT |
displayName(java.lang.String val) |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCatalogItemId() |
java.util.Map<ConfigKey<?>,java.lang.Object> |
getConfig() |
java.lang.String |
getDisplayName() |
java.util.Map<java.lang.String,?> |
getFlags() |
java.util.List<SpecParameter<?>> |
getParameters()
A list of configuration options that the entity supports.
|
java.util.Set<java.lang.Object> |
getTags() |
java.lang.Class<? extends T> |
getType() |
int |
hashCode() |
SpecT |
parameters(java.util.List<? extends SpecParameter<?>> parameters) |
SpecT |
parametersAdd(java.util.List<? extends SpecParameter<?>> parameters)
adds the given parameters
|
SpecT |
parametersReplace(java.util.List<? extends SpecParameter<?>> parameters)
replaces parameters with the given
|
<V> SpecT |
removeConfig(ConfigKey<V> key) |
SpecT |
tag(java.lang.Object tag) |
SpecT |
tags(java.lang.Iterable<java.lang.Object> tagsToAdd)
adds the given tags
|
SpecT |
tagsAdd(java.lang.Iterable<java.lang.Object> tagsToAdd)
adds the given tags
|
SpecT |
tagsReplace(java.lang.Iterable<java.lang.Object> tagsToReplace)
replaces tags with the given
|
java.lang.String |
toString() |
public java.lang.String toString()
toString in class java.lang.Objectpublic SpecT displayName(java.lang.String val)
public SpecT catalogItemId(java.lang.String val)
public SpecT catalogItemIdIfNotNull(java.lang.String val)
public SpecT tag(java.lang.Object tag)
public SpecT tags(java.lang.Iterable<java.lang.Object> tagsToAdd)
public SpecT tagsAdd(java.lang.Iterable<java.lang.Object> tagsToAdd)
public SpecT tagsReplace(java.lang.Iterable<java.lang.Object> tagsToReplace)
public SpecT parameters(java.util.List<? extends SpecParameter<?>> parameters)
public SpecT parametersAdd(java.util.List<? extends SpecParameter<?>> parameters)
public SpecT parametersReplace(java.util.List<? extends SpecParameter<?>> parameters)
public java.lang.Class<? extends T> getType()
public final java.lang.String getDisplayName()
public final java.lang.String getCatalogItemId()
public final java.util.Set<java.lang.Object> getTags()
public final java.util.List<SpecParameter<?>> getParameters()
public boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic SpecT configure(java.util.Map<?,?> val)
public SpecT configure(java.lang.CharSequence key, java.lang.Object val)
public <V> SpecT configure(ConfigKey.HasConfigKey<V> key, V val)
public <V> SpecT configure(ConfigKey.HasConfigKey<V> key, Task<? extends V> val)
public void clearConfig()
public java.util.Map<java.lang.String,?> getFlags()
declarations on the policy typepublic java.util.Map<ConfigKey<?>,java.lang.Object> getConfig()