org.apache.brooklyn.api.objs

Interface SpecParameter<T>

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasicSpecParameter

public interface SpecParameter<T>
extends java.io.Serializable

A wrapper around a ConfigKey which will be added to an Entity, providing additional information for rendering in a UI

Method Summary

Modifier and Type	Method and Description
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
boolean	isPinned() Whether visible by default in UI, not all inputs may be visible at once

Method Detail

getLabel

java.lang.String getLabel()

Short name, to be used in UI

isPinned

boolean isPinned()

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

getConfigKey

ConfigKey<T> getConfigKey()

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

getSensor

@Nullable
AttributeSensor<?> getSensor()

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