Class ConfigDescriptionParameterGroup


  • @NonNullByDefault
    public class ConfigDescriptionParameterGroup
    extends Object
    The ConfigDescriptionParameterGroup specifies information about parameter groups. A parameter group is used to group a number of parameters together so they can be displayed together in the UI (eg in a single tab).

    A ConfigDescriptionParameter instance must also contain the groupName. It should be permissible to use the groupId in the ConfigDesctiptionParameter without supplying a corresponding ConfigDescriptionParameterGroup - in this way the UI can group the parameters together, but doesn't have the group information.

    Author:
    Chris Jackson - Initial contribution
    • Constructor Detail

      • ConfigDescriptionParameterGroup

        public ConfigDescriptionParameterGroup​(String name,
                                               @Nullable String context,
                                               Boolean advanced,
                                               @Nullable String label,
                                               @Nullable String description)
        Create a Parameter Group. A group is used by the user interface to display groups of parameters together.
        Parameters:
        name - the name, used to link the group, to the parameter
        context - a context string. Can be used to provide some context to the group
        advanced - a flag that is set to true if this group contains advanced settings
        label - the human readable group label
        description - a description that can be provided to the user
    • Method Detail

      • getName

        public String getName()
        Get the name of the group.
        Returns:
        groupName as string
      • getContext

        public @Nullable String getContext()
        Get the context of the group.
        Returns:
        group context as a string
      • isAdvanced

        public boolean isAdvanced()
        Gets the advanced flag for this group.
        Returns:
        advanced flag - true if the group contains advanced properties
      • getLabel

        public @Nullable String getLabel()
        Get the human readable label of the group
        Returns:
        group label as a string
      • getDescription

        public @Nullable String getDescription()
        Get the human readable description of the parameter group
        Returns:
        group description as a string