Class EPPRegistryDomainName

  • All Implemented Interfaces:
    EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

    public class EPPRegistryDomainName
    extends java.lang.Object
    implements EPPCodecComponent
    This class is encoded to the <registry:domainName> element inside the <registry:domain> element. It represents policies for a domain name label for a specific level, defined with the "level" attribute, with a minimum value of "2" for the second level domain name label level. The <registry:domainName> element contains the following child elements

    See Also:
    EPPRegistryDomain, EPPRegistryReservedNames, Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELM_LOCALNAME
      XML local name for EPPRegistryDomainName.
      static java.lang.String ELM_NAME
      XML root tag for EPPRegistryDomainName.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Clone EPPRegistryDomainName.
      void decode​(org.w3c.dom.Element aElement)
      Decode the EPPRegistryDomainName attributes from the aElement DOM Element tree.
      org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
      Encode a DOM Element tree from the attributes of the EPPRegistryDomainName instance.
      boolean equals​(java.lang.Object aObject)
      implements a deep EPPRegistryDomainName compare.
      java.lang.Boolean getALabelSupported()
      Get whether ASCII domain names are supported.
      java.lang.Boolean getAlphaNumEnd()
      Get whether or not to allow domain name end with an alphanumeric character.
      java.lang.Boolean getAlphaNumStart()
      Get whether or not to allow domain name start with an alphanumeric character.
      java.lang.Integer getLevel()
      Get the level of domain name.
      java.lang.Integer getMaxLength()
      Get maximum number of characters in a domain name.
      java.lang.Integer getMinLength()
      Get minimum number of characters in a domain name.
      EPPRegistryRegex getNameRegex()
      Get the regular expression that domain name must follow.
      java.lang.String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      EPPRegistryReservedNames getReservedNames()
      Get the instance of EPPRegistryReservedNames that defines a set of reserved domain names.
      java.lang.Boolean getULabelSupported()
      Get whether non-ASCII domain names are supported.
      boolean hasNameRegex()
      Is the domain name regular expression defined?
      void setALabelSupported​(java.lang.Boolean aALabelSupported)
      Set whether whether ASCII domain names are supported.
      void setAlphaNumEnd​(java.lang.Boolean alphaNumEnd)
      Set whether or not to allow domain name end with an alphanumeric character.
      void setAlphaNumStart​(java.lang.Boolean alphaNumStart)
      Set whether or not to allow domain name start with an alphanumeric character.
      void setLevel​(java.lang.Integer level)
      Set the level of domain name.
      void setMaxLength​(java.lang.Integer maxLength)
      Set maximum number of characters in a domain name.
      void setMinLength​(java.lang.Integer minLength)
      Set minimum number of characters in a domain name.
      void setNameRegex​(EPPRegistryRegex aNameRegex)
      Set the regular expression that domain name must follow.
      void setReservedNames​(EPPRegistryReservedNames reservedNames)
      Set the instance of EPPRegistryReservedNames that defines a set of reserved domain names.
      void setULabelSupported​(java.lang.Boolean aULabelSupported)
      Set whether non-ASCII domain names are supported.
      java.lang.String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      • Methods inherited from class java.lang.Object

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

      • ELM_LOCALNAME

        public static final java.lang.String ELM_LOCALNAME
        XML local name for EPPRegistryDomainName.
        See Also:
        Constant Field Values
      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML root tag for EPPRegistryDomainName.
        See Also:
        Constant Field Values
    • Constructor Detail

      • EPPRegistryDomainName

        public EPPRegistryDomainName()
    • Method Detail

      • encode

        public org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
                                   throws EPPEncodeException
        Encode a DOM Element tree from the attributes of the EPPRegistryDomainName instance.
        Specified by:
        encode in interface EPPCodecComponent
        Parameters:
        aDocument - DOM Document that is being built. Used as an Element factory.
        Returns:
        Element Root DOM Element representing the EPPRegistryDomainName instance.
        Throws:
        EPPEncodeException - - Unable to encode EPPRegistryDomainName instance.
      • decode

        public void decode​(org.w3c.dom.Element aElement)
                    throws EPPDecodeException
        Decode the EPPRegistryDomainName attributes from the aElement DOM Element tree.
        Specified by:
        decode in interface EPPCodecComponent
        Parameters:
        aElement - Root DOM Element to decode EPPRegistryDomainName from.
        Throws:
        EPPDecodeException - Unable to decode aElement
      • equals

        public boolean equals​(java.lang.Object aObject)
        implements a deep EPPRegistryDomainName compare.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        aObject - EPPRegistryDomainName instance to compare with
        Returns:
        true if this object is the same as the aObject argument; false otherwise
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Clone EPPRegistryDomainName.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class java.lang.Object
        Returns:
        clone of EPPRegistryDomainName
        Throws:
        java.lang.CloneNotSupportedException - standard Object.clone exception
      • toString

        public java.lang.String toString()
        Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
        Overrides:
        toString in class java.lang.Object
        Returns:
        Indented XML String if successful; ERROR otherwise.
      • getLevel

        public java.lang.Integer getLevel()
        Get the level of domain name.
        Returns:
        level of domain name. Must be >= 2
      • setLevel

        public void setLevel​(java.lang.Integer level)
        Set the level of domain name.
        Parameters:
        level - level of domain name. Must be >= 2
      • getMinLength

        public java.lang.Integer getMinLength()
        Get minimum number of characters in a domain name.
        Returns:
        minimum number of characters in a domain name
      • setMinLength

        public void setMinLength​(java.lang.Integer minLength)
        Set minimum number of characters in a domain name.
        Parameters:
        minLength - minimum number of characters in a domain name
      • getMaxLength

        public java.lang.Integer getMaxLength()
        Get maximum number of characters in a domain name.
        Returns:
        maximum number of characters in a domain name
      • setMaxLength

        public void setMaxLength​(java.lang.Integer maxLength)
        Set maximum number of characters in a domain name.
        Parameters:
        maxLength - maximum number of characters in a domain name
      • getAlphaNumStart

        public java.lang.Boolean getAlphaNumStart()
        Get whether or not to allow domain name start with an alphanumeric character.
        Returns:
        true allow domain name start with an alphanumeric character. false do not allow domain name start with an alphanumeric character
      • setAlphaNumStart

        public void setAlphaNumStart​(java.lang.Boolean alphaNumStart)
        Set whether or not to allow domain name start with an alphanumeric character.
        Parameters:
        alphaNumStart - true allow domain name start with an alphanumeric character. false do not allow domain name start with an alphanumeric character
      • getAlphaNumEnd

        public java.lang.Boolean getAlphaNumEnd()
        Get whether or not to allow domain name end with an alphanumeric character.
        Returns:
        true allow domain name end with an alphanumeric character. false do not allow domain name end with an alphanumeric character
      • setAlphaNumEnd

        public void setAlphaNumEnd​(java.lang.Boolean alphaNumEnd)
        Set whether or not to allow domain name end with an alphanumeric character.
        Parameters:
        alphaNumEnd - true allow domain name end with an alphanumeric character. false do not allow domain name end with an alphanumeric character
      • getALabelSupported

        public java.lang.Boolean getALabelSupported()
        Get whether ASCII domain names are supported.
        Returns:
        true if ASCII domain names are supported; false otherwise.
      • setALabelSupported

        public void setALabelSupported​(java.lang.Boolean aALabelSupported)
        Set whether whether ASCII domain names are supported.
        Parameters:
        aALabelSupported - true ASCII domain names are supported; false otherwise.
      • getULabelSupported

        public java.lang.Boolean getULabelSupported()
        Get whether non-ASCII domain names are supported.
        Returns:
        true if non-ASCII domain names are supported; false otherwise.
      • setULabelSupported

        public void setULabelSupported​(java.lang.Boolean aULabelSupported)
        Set whether non-ASCII domain names are supported.
        Parameters:
        aULabelSupported - true non-ASCII domain names are supported; false otherwise.
      • hasNameRegex

        public boolean hasNameRegex()
        Is the domain name regular expression defined?
        Returns:
        true if the domain name regular expression is defined; false otherwise.
      • getNameRegex

        public EPPRegistryRegex getNameRegex()
        Get the regular expression that domain name must follow.
        Returns:
        Regular expression if defined; null otherwise.
      • setNameRegex

        public void setNameRegex​(EPPRegistryRegex aNameRegex)
        Set the regular expression that domain name must follow.
        Parameters:
        aNameRegex - Regular expression for the domain name label. Set to null to unset it.
      • getNamespace

        public java.lang.String getNamespace()
        Returns the XML namespace associated with the EPPCodecComponent.
        Specified by:
        getNamespace in interface EPPCodecComponent
        Returns:
        XML namespace for the EPPCodecComponent.