Class EPPIdnTableInfoDomainTable

java.lang.Object
com.verisign.epp.codec.idntable.EPPIdnTableInfoDomainTable
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable

public class EPPIdnTableInfoDomainTable extends Object implements EPPCodecComponent
EPPIdnTableInfoDomainTable is used to represent the Internationalized Domain Name (IDN) table information for a domain name in a Domain Info Form response.
See Also:
  • Field Details

  • Constructor Details

    • EPPIdnTableInfoDomainTable

      public EPPIdnTableInfoDomainTable()
      Default constructor for EPPIdnTableInfoDomainTable.
    • EPPIdnTableInfoDomainTable

      public EPPIdnTableInfoDomainTable(String aName, EPPIdnTableInfoDomainTable.Type aType, String aDescription)
      Constructor for EPPIdnTableInfoDomainTable that takes the required attributes.
      Parameters:
      aName - Table identifier
      aType - IDN Table type
      aDescription - Server defined description of the IDN Table.
    • EPPIdnTableInfoDomainTable

      public EPPIdnTableInfoDomainTable(String aName, EPPIdnTableInfoDomainTable.Type aType, String aDescription, String aDescriptionLang, Boolean aVariantGen)
      Constructor for EPPIdnTableInfoDomainTable that takes the all attributes.
      Parameters:
      aName - Table identifier
      aType - IDN Table type
      aDescription - Server defined description of the IDN Table.
      aDescriptionLang - Language of the description
      aVariantGen - Flag indicating that domains created with the IDN Table will have IDN variants generated.
  • Method Details

    • getName

      public String getName()
      Gets the IDN Table identifier.
      Returns:
      The IDN Table identifier
    • setName

      public void setName(String aName)
      Sets the IDN Table identifier.
      Parameters:
      aName - The IDN Table identifier.
    • getType

      Gets the IDN Table type
      Returns:
      Type of the IDN table
    • setType

      public void setType(EPPIdnTableInfoDomainTable.Type aType)
      Sets the IDN Table type.
      Parameters:
      aType - IDN type
    • getDescription

      public String getDescription()
      Gets the server defined description of the IDN Table.
      Returns:
      The server defined description of the IDN Table.
    • setDescription

      public void setDescription(String aDescription)
      Sets the server defined description of the IDN Table.
      Parameters:
      aDescription - The server defined description of the IDN Table.
    • hasDescriptionLang

      public boolean hasDescriptionLang()
      Is the description language defined?
      Returns:
      true if the description language is defined; false otherwise.
    • getDescriptionLang

      public String getDescriptionLang()
      Gets the language of the description of the IDN Table with the default value of "en".
      Returns:
      The language of the description.
    • setDescriptionLang

      public void setDescriptionLang(String aDescriptionLang)
      Sets the language of the description of the IDN Table.
      Parameters:
      aDescriptionLang - The language of the description.
    • hasVariantGen

      public boolean hasVariantGen()
      Is the variant generation flag defined?
      Returns:
      true if the variant generation flag is defined; false otherwise.
    • getVariantGen

      public Boolean getVariantGen()
      Gets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.
      Returns:
      true or false indicating that the domains created using the IDN Table will have IDN variants generated if defined; null otherwise.
    • setVariantGen

      public void setVariantGen(Boolean aVariantGen)
      Sets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.
      Parameters:
      aVariantGen - Non-null value indicating that the domains created using the IDN Table will have IDN variants generated. Use null to clear the flag.
    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPIdnTableInfoDomainTable
    • decode

      public void decode(Element aElement) throws EPPDecodeException
      decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element
    • clone

      public Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPIdnTableInfoDomainTable
      Throws:
      CloneNotSupportedException - standard Object.clone exception
    • toString

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

      public boolean equals(Object aObject)
      Compare an instance of EPPIdnTableInfoDomainTable with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.
    • getNamespace

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