Class StructuredDataId

    • Constructor Summary

      Constructors 
      Constructor Description
      StructuredDataId​(java.lang.String name)
      Creates a StructuredDataId based on the name.
      StructuredDataId​(java.lang.String name, int maxLength)
      Creates a StructuredDataId based on the name.
      StructuredDataId​(java.lang.String name, int enterpriseNumber, java.lang.String[] required, java.lang.String[] optional)
      A Constructor that helps conformance to RFC 5424.
      StructuredDataId​(java.lang.String name, int enterpriseNumber, java.lang.String[] required, java.lang.String[] optional, int maxLength)
      A Constructor that helps conformance to RFC 5424.
      StructuredDataId​(java.lang.String name, java.lang.String[] required, java.lang.String[] optional)  
      StructuredDataId​(java.lang.String name, java.lang.String[] required, java.lang.String[] optional, int maxLength)
      A Constructor that helps conformance to RFC 5424.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void formatTo​(java.lang.StringBuilder buffer)
      Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.
      int getEnterpriseNumber()
      Returns the enterprise number.
      java.lang.String getName()
      Returns the StructuredDataId name.
      java.lang.String[] getOptional()
      Returns a list of optional keys.
      java.lang.String[] getRequired()
      Returns a list of required keys.
      boolean isReserved()
      Indicates if the id is reserved.
      StructuredDataId makeId​(java.lang.String defaultId, int anEnterpriseNumber)
      Creates an id based on the current id.
      StructuredDataId makeId​(StructuredDataId id)
      Creates an id using another id to supply default values.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • StructuredDataId

        public StructuredDataId​(java.lang.String name)
        Creates a StructuredDataId based on the name.
        Parameters:
        name - The Structured Data Element name (maximum length is 32)
        Since:
        2.9
      • StructuredDataId

        public StructuredDataId​(java.lang.String name,
                                int maxLength)
        Creates a StructuredDataId based on the name.
        Parameters:
        name - The Structured Data Element name.
        maxLength - The maximum length of the name.
        Since:
        2.9
      • StructuredDataId

        public StructuredDataId​(java.lang.String name,
                                java.lang.String[] required,
                                java.lang.String[] optional)
        Parameters:
        name -
        required -
        optional -
      • StructuredDataId

        public StructuredDataId​(java.lang.String name,
                                java.lang.String[] required,
                                java.lang.String[] optional,
                                int maxLength)
        A Constructor that helps conformance to RFC 5424.
        Parameters:
        name - The name portion of the id.
        required - The list of keys that are required for this id.
        optional - The list of keys that are optional for this id.
        Since:
        2.9
      • StructuredDataId

        public StructuredDataId​(java.lang.String name,
                                int enterpriseNumber,
                                java.lang.String[] required,
                                java.lang.String[] optional)
        A Constructor that helps conformance to RFC 5424.
        Parameters:
        name - The name portion of the id.
        enterpriseNumber - The enterprise number.
        required - The list of keys that are required for this id.
        optional - The list of keys that are optional for this id.
      • StructuredDataId

        public StructuredDataId​(java.lang.String name,
                                int enterpriseNumber,
                                java.lang.String[] required,
                                java.lang.String[] optional,
                                int maxLength)
        A Constructor that helps conformance to RFC 5424.
        Parameters:
        name - The name portion of the id.
        enterpriseNumber - The enterprise number.
        required - The list of keys that are required for this id.
        optional - The list of keys that are optional for this id.
        maxLength - The maximum length of the StructuredData Id key.
        Since:
        2.9
    • Method Detail

      • makeId

        public StructuredDataId makeId​(StructuredDataId id)
        Creates an id using another id to supply default values.
        Parameters:
        id - The original StructuredDataId.
        Returns:
        the new StructuredDataId.
      • makeId

        public StructuredDataId makeId​(java.lang.String defaultId,
                                       int anEnterpriseNumber)
        Creates an id based on the current id.
        Parameters:
        defaultId - The default id to use if this StructuredDataId doesn't have a name.
        anEnterpriseNumber - The enterprise number.
        Returns:
        a StructuredDataId.
      • getRequired

        public java.lang.String[] getRequired()
        Returns a list of required keys.
        Returns:
        a List of required keys or null if none have been provided.
      • getOptional

        public java.lang.String[] getOptional()
        Returns a list of optional keys.
        Returns:
        a List of optional keys or null if none have been provided.
      • getName

        public java.lang.String getName()
        Returns the StructuredDataId name.
        Returns:
        the StructuredDataId name.
      • getEnterpriseNumber

        public int getEnterpriseNumber()
        Returns the enterprise number.
        Returns:
        the enterprise number.
      • isReserved

        public boolean isReserved()
        Indicates if the id is reserved.
        Returns:
        true if the id uses the reserved enterprise number, false otherwise.
      • toString

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

        public void formatTo​(java.lang.StringBuilder buffer)
        Description copied from interface: StringBuilderFormattable
        Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.
        Specified by:
        formatTo in interface StringBuilderFormattable
        Parameters:
        buffer - the StringBuilder to write into