Class PropertyGroupTemplate

  • Direct Known Subclasses:
    AddTemplateArg, GetTemplateResult

    public class PropertyGroupTemplate
    extends java.lang.Object
    Defines how a property group may be structured.
    • Constructor Summary

      Constructors 
      Constructor Description
      PropertyGroupTemplate​(java.lang.String name, java.lang.String description, java.util.List<PropertyFieldTemplate> fields)
      Defines how a property group may be structured.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getDescription()
      Description for the template.
      java.util.List<PropertyFieldTemplate> getFields()
      Definitions of the property fields associated with this template.
      java.lang.String getName()
      Display name for the template.
      int hashCode()  
      java.lang.String toString()  
      java.lang.String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • name

        @Nonnull
        protected final java.lang.String name
      • description

        @Nonnull
        protected final java.lang.String description
    • Constructor Detail

      • PropertyGroupTemplate

        public PropertyGroupTemplate​(@Nonnull
                                     java.lang.String name,
                                     @Nonnull
                                     java.lang.String description,
                                     @Nonnull
                                     java.util.List<PropertyFieldTemplate> fields)
        Defines how a property group may be structured.
        Parameters:
        name - Display name for the template. Template names can be up to 256 bytes. Must not be null.
        description - Description for the template. Template descriptions can be up to 1024 bytes. Must not be null.
        fields - Definitions of the property fields associated with this template. There can be up to 32 properties in a single template. Must not contain a null item and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
    • Method Detail

      • getName

        @Nonnull
        public java.lang.String getName()
        Display name for the template. Template names can be up to 256 bytes.
        Returns:
        value for this field, never null.
      • getDescription

        @Nonnull
        public java.lang.String getDescription()
        Description for the template. Template descriptions can be up to 1024 bytes.
        Returns:
        value for this field, never null.
      • getFields

        @Nonnull
        public java.util.List<PropertyFieldTemplate> getFields()
        Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.
        Returns:
        value for this field, never null.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Returns:
        Formatted, multiline String representation of this object