Package org.openhab.core.config.core

Class ConfigDescriptionParameterGroup

java.lang.Object
org.openhab.core.config.core.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 ConfigDescriptionParameter 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

  • Method Details

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object