Package com.verisign.epp.codec.idntable
Class EPPIdnTableInfoDomainTable
java.lang.Object
com.verisign.epp.codec.idntable.EPPIdnTableInfoDomainTable
- All Implemented Interfaces:
EPPCodecComponent,Serializable,Cloneable
EPPIdnTableInfoDomainTable is used to represent the
Internationalized Domain Name (IDN) table information for a domain name in a
Domain Info Form response.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumTable types, that include:
LANGUAGEthat represents a Language IDN Table.SCRIPTthat represents a Script IDN Table. -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor forEPPIdnTableInfoDomainTable.EPPIdnTableInfoDomainTable(String aName, EPPIdnTableInfoDomainTable.Type aType, String aDescription) Constructor forEPPIdnTableInfoDomainTablethat takes the required attributes.EPPIdnTableInfoDomainTable(String aName, EPPIdnTableInfoDomainTable.Type aType, String aDescription, String aDescriptionLang, Boolean aVariantGen) Constructor forEPPIdnTableInfoDomainTablethat takes the all attributes. -
Method Summary
Modifier and TypeMethodDescriptionclone()clone anEPPCodecComponent.voiddecode a DOM element tree to initialize the instance attributes.encode instance into a DOM element tree.booleanCompare an instance ofEPPIdnTableInfoDomainTablewith this instance.Gets the server defined description of the IDN Table.Gets the language of the description of the IDN Table with the default value of "en".getName()Gets the IDN Table identifier.Returns the XML namespace associated with theEPPCodecComponent.getType()Gets the IDN Table typeGets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.booleanIs the description language defined?booleanIs the variant generation flag defined?voidsetDescription(String aDescription) Sets the server defined description of the IDN Table.voidsetDescriptionLang(String aDescriptionLang) Sets the language of the description of the IDN Table.voidSets the IDN Table identifier.voidSets the IDN Table type.voidsetVariantGen(Boolean aVariantGen) Sets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.toString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.
-
Field Details
-
ELM_LOCALNAME
XML local name forEPPIdnTableInfoDomainTable.- See Also:
-
ELM_NAME
XML root tag forEPPIdnTableInfoDomainTable.- See Also:
-
-
Constructor Details
-
EPPIdnTableInfoDomainTable
public EPPIdnTableInfoDomainTable()Default constructor forEPPIdnTableInfoDomainTable. -
EPPIdnTableInfoDomainTable
public EPPIdnTableInfoDomainTable(String aName, EPPIdnTableInfoDomainTable.Type aType, String aDescription) Constructor forEPPIdnTableInfoDomainTablethat takes the required attributes.- Parameters:
aName- Table identifieraType- IDN Table typeaDescription- Server defined description of the IDN Table.
-
EPPIdnTableInfoDomainTable
public EPPIdnTableInfoDomainTable(String aName, EPPIdnTableInfoDomainTable.Type aType, String aDescription, String aDescriptionLang, Boolean aVariantGen) Constructor forEPPIdnTableInfoDomainTablethat takes the all attributes.- Parameters:
aName- Table identifieraType- IDN Table typeaDescription- Server defined description of the IDN Table.aDescriptionLang- Language of the descriptionaVariantGen- Flag indicating that domains created with the IDN Table will have IDN variants generated.
-
-
Method Details
-
getName
Gets the IDN Table identifier.- Returns:
- The IDN Table identifier
-
setName
Sets the IDN Table identifier.- Parameters:
aName- The IDN Table identifier.
-
getType
Gets the IDN Table type- Returns:
- Type of the IDN table
-
setType
Sets the IDN Table type.- Parameters:
aType- IDN type
-
getDescription
Gets the server defined description of the IDN Table.- Returns:
- The server defined description of the IDN Table.
-
setDescription
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:
trueif the description language is defined;falseotherwise.
-
getDescriptionLang
Gets the language of the description of the IDN Table with the default value of "en".- Returns:
- The language of the description.
-
setDescriptionLang
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:
trueif the variant generation flag is defined;falseotherwise.
-
getVariantGen
Gets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.- Returns:
trueorfalseindicating that the domains created using the IDN Table will have IDN variants generated if defined;nullotherwise.
-
setVariantGen
Sets the OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated.- Parameters:
aVariantGen- Non-nullvalue indicating that the domains created using the IDN Table will have IDN variants generated. Usenullto clear the flag.
-
encode
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:
encodein interfaceEPPCodecComponent- Parameters:
aDocument- DOM Document, which acts is an Element factory- Returns:
- Element Root element associated with the object
- Throws:
EPPEncodeException- Error encodingEPPIdnTableInfoDomainTable
-
decode
decode a DOM element tree to initialize the instance attributes. TheaElementargument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.- Specified by:
decodein interfaceEPPCodecComponent- Parameters:
aElement-Elementto decode- Throws:
EPPDecodeException- Error decodingElement
-
clone
clone anEPPCodecComponent.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classObject- Returns:
- clone of concrete
EPPIdnTableInfoDomainTable - Throws:
CloneNotSupportedException- standard Object.clone exception
-
toString
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent. -
equals
Compare an instance ofEPPIdnTableInfoDomainTablewith this instance. -
getNamespace
Returns the XML namespace associated with theEPPCodecComponent.- Specified by:
getNamespacein interfaceEPPCodecComponent- Returns:
- XML namespace for the
EPPCodecComponent.
-