org.hippoecm.hst.core.parameters

Annotation Type Parameter

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Parameter

Annotation indicating that a getter method returns the value of an HST parameter.

See Also:

ParametersInfo

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends PropertyEditor>	customEditor This is still experimental.
String	defaultValue
String	description Deprecated. this value is not used anywhere. To provide extra information about a parameter to the user, configure component parameter hints in the ParametersInfo class resource bundle.
String	displayName
boolean	hideInChannelManager
boolean	required

Element Detail

name

public abstract String name

Returns:

the name of the parameter used, also see org.hippoecm.hst.configuration.components.HstComponentConfiguration#getParameter(String). This element is mandatory.

required

public abstract boolean required

Returns:

true if this is a required parameter for the org.hippoecm.hst.core.component.HstComponent to work

Default:

false

defaultValue

public abstract String defaultValue

Returns:

the default value of this parameter when it is not present in the backing org.hippoecm.hst.configuration.components.HstComponentConfiguration#getParameters(). If there is no defaultValue defined, it is an empty String ""

Default:

""

displayName

public abstract String displayName

Returns:

the displayName of this parameter. This can be the 'pretty' name for name(). If missing, implementations can do a fallback to name()

Default:

""

description

@Deprecated
public abstract String description

Deprecated. this value is not used anywhere. To provide extra information about a parameter to the user, configure component parameter hints in the ParametersInfo class resource bundle.

Returns:

the description for this Parameter

Default:

""

hideInChannelManager

public abstract boolean hideInChannelManager

Returns:

true if the parameter should not be shown in the channel manager UI

Default:

false

customEditor

public abstract Class<? extends PropertyEditor> customEditor

This is still experimental.

Returns:

a PropertyEditor

Default:

org.hippoecm.hst.core.parameters.EmptyPropertyEditor.class