Package com.pnfsoftware.jeb.core.properties

Interface IPropertyDefinitionGroup

public interface IPropertyDefinitionGroup
A group of property definitions. Groups offer an additional way to separate properties stored within a same namespace (PDM).

  • Method Details

    • isDefaultGroup

      default boolean isDefaultGroup()
      Determine whether this group is the anonymous default group.
      Returns:
      true if this is the default group

    • getName

      String getName()
      Retrieve the group name. A PDM's properties are stored in the default group by default, which is the anonymous (empty name) group.
      Returns:
      the group name, or the empty string for the default group

    • getDefinitions

      List<IPropertyDefinition> getDefinitions()
      Retrieve the definitions stored in the group.
      Returns:
      the property definitions belonging to the group

    • addDefinition

      default IPropertyDefinition addDefinition(String name, IPropertyType type)
      Add a definition to the group.
      Parameters:
      name - property name
      type - property type
      Returns:
      the newly created definition

    • addDefinition

      default IPropertyDefinition addDefinition(String name, IPropertyType type, String description)
      Add a definition to the group.
      Parameters:
      name - property name
      type - property type
      description - optional property description
      Returns:
      the newly created definition

    • addDefinition

      IPropertyDefinition addDefinition(String name, IPropertyType type, String description, int flags)
      Add a definition to the group.
      Parameters:
      name - property name
      type - property type
      description - optional property description
      flags - property flags, using IPropertyDefinition.FLAG_INTERNAL and related constants
      Returns:
      the newly created definition

    • removeDefinition

      void removeDefinition(String name)
      Remove a definition from the group.
      Parameters:
      name -