Package org.hippoecm.hst.core.parameters

Annotation Interface Parameter

@Retention(RUNTIME) @Target(METHOD) public @interface Parameter
Annotation indicating that a getter method returns the value of an HST parameter.
See Also:

  • Element Details

    • name

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

    • required

      boolean required
      Returns:
      true if this is a required parameter for the org.hippoecm.hst.core.component.HstComponent to work
      Default:
      false

    • defaultValue

      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

      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 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

      boolean hideInChannelManager
      Returns:
      true if the parameter should not be shown in the channel manager UI
      Default:
      false

    • customEditor

      Class<? extends PropertyEditor> customEditor
      This is still experimental.
      Returns:
      a PropertyEditor
      Default:
      org.hippoecm.hst.core.parameters.EmptyPropertyEditor.class