Package com.verisign.epp.codec.idntable

Class EPPIdnTableInfoTable

java.lang.Object
com.verisign.epp.codec.idntable.EPPIdnTableInfoTable
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPIdnTableInfoTable extends Object implements EPPCodecComponent
EPPIdnTableInfoTable is used to represent the Internationalized Domain Name (IDN) table information for an IDN Table in a Table Info Form response.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    EPPIdnTableInfoTable.Type
    Table types, that include:
    LANGUAGE that represents a Language IDN Table. SCRIPT that represents a Script IDN Table.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPIdnTableInfoTable.
    static final String
    ELM_NAME
    XML root tag for EPPIdnTableInfoTable.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPIdnTableInfoTable()
    Default constructor for EPPIdnTableInfoTable.
    EPPIdnTableInfoTable(String aName, EPPIdnTableInfoTable.Type aType, String aDescription, Date aUpdateDate)
    Constructor for EPPIdnTableInfoTable that takes the required attributes.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    clone an EPPCodecComponent.
    void
    decode(Element aElement)
    decode a DOM element tree to initialize the instance attributes.
    Element
    encode(Document aDocument)
    encode instance into a DOM element tree.
    boolean
    equals(Object aObject)
    Compare an instance of EPPIdnTableInfoTable with this instance.
    String
    getDescription()
    Gets the server defined description of the IDN Table.
    String
    getDescriptionLang()
    Gets the language of the description of the IDN Table with the default value of "en".
    Date
    getEffectiveDate()
    Gets the OPTIONAL effective date of the IDN Table.
    String
    getName()
    Gets the IDN Table identifier.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    EPPIdnTableInfoTable.Type
    getType()
    Gets the IDN Table type
    Date
    getUpdateDate()
    Gets the date and time that the IDN Table was created or last updated.
    String
    getUrl()
    Gets the OPTIONAL URL for downloading the IDN Table with the applicable set of code points and rules.
    Boolean
    getVariantGen()
    Gets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.
    String
    getVersion()
    Gets the OPTIONAL server defined version number of the IDN Table.
    boolean
    hasDescriptionLang()
    Is the description language defined?
    boolean
    hasEffectiveDate()
    Is the effective date defined?
    boolean
    hasUrl()
    Is the URL defined?
    boolean
    hasVariantGen()
    Is the variant generation flag defined?
    boolean
    hasVersion()
    Is the version defined?
    void
    setDescription(String aDescription)
    Sets the server defined description of the IDN Table.
    void
    setDescriptionLang(String aDescriptionLang)
    Sets the language of the description of the IDN Table.
    void
    setEffectiveDate(Date aEffectiveDate)
    Sets the OPTIONAL effective date of the IDN Table.
    void
    setName(String aName)
    Sets the IDN Table identifier.
    void
    setType(EPPIdnTableInfoTable.Type aType)
    Sets the IDN Table type.
    void
    setUpdateDate(Date aUpdateDate)
    Sets the date and time that the IDN Table was created or last updated.
    void
    setUrl(String aUrl)
    Sets the OPTIONAL URL for downloading the IDN Table with the applicable set of code points and rules.
    void
    setVariantGen(Boolean aVariantGen)
    Sets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.
    void
    setVersion(String aVersion)
    Sets the OPTIONAL server defined version number of the IDN Table.
    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 Details

  • Constructor Details

    • EPPIdnTableInfoTable

      public EPPIdnTableInfoTable()
      Default constructor for EPPIdnTableInfoTable.

    • EPPIdnTableInfoTable

      public EPPIdnTableInfoTable(String aName, EPPIdnTableInfoTable.Type aType, String aDescription, Date aUpdateDate)
      Constructor for EPPIdnTableInfoTable that takes the required attributes.
      Parameters:
      aName - Table identifier
      aType - IDN Table type
      aDescription - Server defined description of the IDN Table.
      aUpdateDate - Date and time the IDN Table was created or last updated.

  • 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

      public EPPIdnTableInfoTable.Type getType()
      Gets the IDN Table type
      Returns:
      Type of the IDN table

    • setType

      public void setType(EPPIdnTableInfoTable.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.

    • getUpdateDate

      public Date getUpdateDate()
      Gets the date and time that the IDN Table was created or last updated.
      Returns:
      Date and time the IDN Table was created or last updated.

    • setUpdateDate

      public void setUpdateDate(Date aUpdateDate)
      Sets the date and time that the IDN Table was created or last updated.
      Parameters:
      aUpdateDate - Date and time the IDN Table was created or last updated.

    • hasVersion

      public boolean hasVersion()
      Is the version defined?
      Returns:
      true if the version is defined; false otherwise.

    • getVersion

      public String getVersion()
      Gets the OPTIONAL server defined version number of the IDN Table.
      Returns:
      Server defined version of of the IDN Table if defined; null otherwise.

    • setVersion

      public void setVersion(String aVersion)
      Sets the OPTIONAL server defined version number of the IDN Table.
      Parameters:
      aVersion - Server defined version of of the IDN Table. Set to null to clear the attribute.

    • hasEffectiveDate

      public boolean hasEffectiveDate()
      Is the effective date defined?
      Returns:
      true if the effective date is defined; false otherwise.

    • getEffectiveDate

      public Date getEffectiveDate()
      Gets the OPTIONAL effective date of the IDN Table.
      Returns:
      The effective date of the IDN Table if defined; null otherwise.

    • setEffectiveDate

      public void setEffectiveDate(Date aEffectiveDate)
      Sets the OPTIONAL effective date of the IDN Table.
      Parameters:
      aEffectiveDate - The effective date of the IDN Table. Set to null to clear the attribute.

    • 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.

    • hasUrl

      public boolean hasUrl()
      Is the URL defined?
      Returns:
      true if the URL is defined; false otherwise.

    • getUrl

      public String getUrl()
      Gets the OPTIONAL URL for downloading the IDN Table with the applicable set of code points and rules.
      Returns:
      The URL for downloading the IDN Table with the applicable set of code points and rules if defined; null otherwise.

    • setUrl

      public void setUrl(String aUrl)
      Sets the OPTIONAL URL for downloading the IDN Table with the applicable set of code points and rules.
      Parameters:
      aUrl - The URL for downloading the IDN Table with the applicable set of code points and rules. Set to null to clear the attribute.

    • 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 EPPIdnTableInfoTable

    • 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 EPPIdnTableInfoTable
      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 EPPIdnTableInfoTable 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.