org.apache.brooklyn.core.objs

Class BasicSpecParameter<T>

java.lang.Object

org.apache.brooklyn.core.objs.BasicSpecParameter<T>

All Implemented Interfaces:

java.io.Serializable, SpecParameter<T>

public class BasicSpecParameter<T>
extends java.lang.Object
implements SpecParameter<T>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicSpecParameter(java.lang.String label, boolean pinned, ConfigKey<T> config)
BasicSpecParameter(java.lang.String label, boolean pinned, ConfigKey<T> config, AttributeSensor<SensorType> sensor)

Method Summary

Modifier and Type	Method and Description
static void	addCustomTypeNameInference(java.lang.String ruleName, java.util.function.BiFunction<java.lang.String,BrooklynClassLoadingContext,<any>> rule) Allows extensions to define additional types that are supported for parameters in YAML.
boolean	equals(java.lang.Object obj)
static java.util.List<SpecParameter<?>>	fromClass(ManagementContext mgmt, java.lang.Class<?> type)
static java.util.List<SpecParameter<?>>	fromSpec(ManagementContext mgmt, AbstractBrooklynObjectSpec<?,?> spec)
ConfigKey<T>	getConfigKey() All config key info for this spec parameter; this is the config key which is added to the defined type
java.lang.String	getLabel() Short name, to be used in UI
AttributeSensor<?>	getSensor() An optional sensor which may also be added to the defined type
int	hashCode()
static void	initializeSpecWithExplicitParameters(AbstractBrooklynObjectSpec<?,?> spec, java.util.List<? extends SpecParameter<?>> explicitParams, BrooklynClassLoadingContext loader) Adds the given list of parameters to the provided spec, and if spec has no parameters it also generates a list from the spec
boolean	isPinned() Whether visible by default in UI, not all inputs may be visible at once
static java.util.List<SpecParameter<?>>	parseParameterDefinitionList(java.util.List<?> obj, <any> specialFlagsTransformer, BrooklynClassLoadingContext loader) Returns a list of SpecParameterIncludingDefinitionForInheritance objects from the given list; these should be resolved against ancestors before using, converting that object to BasicSpecParameter instances.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicSpecParameter

public BasicSpecParameter(java.lang.String label,
                          boolean pinned,
                          ConfigKey<T> config)

BasicSpecParameter

public BasicSpecParameter(java.lang.String label,
                          boolean pinned,
                          ConfigKey<T> config,
                          AttributeSensor<SensorType> sensor)

Method Detail

getLabel

public java.lang.String getLabel()

Description copied from interface: SpecParameter

Short name, to be used in UI

Specified by:

getLabel in interface SpecParameter<T>

isPinned

public boolean isPinned()

Description copied from interface: SpecParameter

Whether visible by default in UI, not all inputs may be visible at once

Specified by:

isPinned in interface SpecParameter<T>

getConfigKey

public ConfigKey<T> getConfigKey()

Description copied from interface: SpecParameter

All config key info for this spec parameter; this is the config key which is added to the defined type

Specified by:

getConfigKey in interface SpecParameter<T>

getSensor

public AttributeSensor<?> getSensor()

Description copied from interface: SpecParameter

An optional sensor which may also be added to the defined type

Specified by:

getSensor in interface SpecParameter<T>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parseParameterDefinitionList

public static java.util.List<SpecParameter<?>> parseParameterDefinitionList(java.util.List<?> obj,
                                                                            <any> specialFlagsTransformer,
                                                                            BrooklynClassLoadingContext loader)

Returns a list of SpecParameterIncludingDefinitionForInheritance objects from the given list; these should be resolved against ancestors before using, converting that object to BasicSpecParameter instances.

fromClass

public static java.util.List<SpecParameter<?>> fromClass(ManagementContext mgmt,
                                                         java.lang.Class<?> type)

fromSpec

public static java.util.List<SpecParameter<?>> fromSpec(ManagementContext mgmt,
                                                        AbstractBrooklynObjectSpec<?,?> spec)

addCustomTypeNameInference

public static void addCustomTypeNameInference(java.lang.String ruleName,
                                              java.util.function.BiFunction<java.lang.String,BrooklynClassLoadingContext,<any>> rule)

Allows extensions to define additional types that are supported for parameters in YAML. Rules should return a TypeToken if the given name is known, null if not handled, or throw if the name is decisively problematic. Handlers will throw if no rules match.

initializeSpecWithExplicitParameters

public static void initializeSpecWithExplicitParameters(AbstractBrooklynObjectSpec<?,?> spec,
                                                        java.util.List<? extends SpecParameter<?>> explicitParams,
                                                        BrooklynClassLoadingContext loader)

Adds the given list of parameters to the provided spec, and if spec has no parameters it also generates a list from the spec

See Also:

EntitySpec#parameters(List)