Package com.verisign.epp.codec.idntable
Class EPPIdnTableDomainLabel
- java.lang.Object
-
- com.verisign.epp.codec.idntable.EPPIdnTableDomainLabel
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPIdnTableDomainLabel extends java.lang.Object implements EPPCodecComponent
EPPIdnTableDomainLabel
is used to represent a domain name label used in the Domain Check Form and the Domain Info Form. The domain label consists of the domain name plus an optional "form" attribute that defines whether the domain name is an A-label or U-label, with the default being A-label.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EPPIdnTableDomainLabel.Form
Label form types, that include:
A_LABEL
A-label domain name label.U_LABEL
U-label domain name label.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPIdnTableDomainLabel
.static java.lang.String
ELM_NAME
XML root tag forEPPIdnTableDomainLabel
.static java.lang.String
FORM_A_LABEL
static java.lang.String
FORM_U_LABEL
-
Constructor Summary
Constructors Constructor Description EPPIdnTableDomainLabel()
Default constructor forEPPIdnTableDomainLabel
.EPPIdnTableDomainLabel(java.lang.String aDomain)
Constructor forEPPIdnTableDomainLabel
that takes the domain name.EPPIdnTableDomainLabel(java.lang.String aDomain, EPPIdnTableDomainLabel.Form aForm)
Constructor forEPPIdnTableDomainLabel
that takes the domain name and the form.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
clone anEPPCodecComponent
.void
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPIdnTableDomainLabel
with this instance.java.lang.String
getDomain()
Returns the domain name.EPPIdnTableDomainLabel.Form
getForm()
Gets the form of the domain name that should be eitherForm.A_LABEL
or }Form.U_LABEL}.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.void
setDomain(java.lang.String aDomain)
Sets the domain name.void
setForm(EPPIdnTableDomainLabel.Form aForm)
Sets the form of the domain name that should be eitherForm.A_LABEL
orForm.U_LABEL
.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPIdnTableDomainLabel
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPIdnTableDomainLabel
.- See Also:
- Constant Field Values
-
FORM_A_LABEL
public static final java.lang.String FORM_A_LABEL
- See Also:
- Constant Field Values
-
FORM_U_LABEL
public static final java.lang.String FORM_U_LABEL
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPIdnTableDomainLabel
public EPPIdnTableDomainLabel()
Default constructor forEPPIdnTableDomainLabel
.
-
EPPIdnTableDomainLabel
public EPPIdnTableDomainLabel(java.lang.String aDomain)
Constructor forEPPIdnTableDomainLabel
that takes the domain name.- Parameters:
aDomain
- Domain name
-
EPPIdnTableDomainLabel
public EPPIdnTableDomainLabel(java.lang.String aDomain, EPPIdnTableDomainLabel.Form aForm)
Constructor forEPPIdnTableDomainLabel
that takes the domain name and the form.- Parameters:
aDomain
- Domain nameaForm
- EitherForm.A_LABEL
orForm.U_LABEL
-
-
Method Detail
-
getDomain
public java.lang.String getDomain()
Returns the domain name.- Returns:
- Domain name if defined:
null
otherwise.
-
setDomain
public void setDomain(java.lang.String aDomain)
Sets the domain name.- Parameters:
aDomain
- Domain name
-
getForm
public EPPIdnTableDomainLabel.Form getForm()
Gets the form of the domain name that should be eitherForm.A_LABEL
or }Form.U_LABEL}.- Returns:
- Either
Form.A_LABEL
orForm.U_LABEL
-
setForm
public void setForm(EPPIdnTableDomainLabel.Form aForm)
Sets the form of the domain name that should be eitherForm.A_LABEL
orForm.U_LABEL
.- Parameters:
aForm
- EitherForm.A_LABEL
orForm.U_LABEL
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.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 interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document, which acts is an Element factory- Returns:
- Element Root element associated with the object
- Throws:
EPPEncodeException
- Error encodingEPPIdnTableDomainLabel
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode a DOM element tree to initialize the instance attributes. TheaElement
argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
-Element
to decode- Throws:
EPPDecodeException
- Error decodingElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone anEPPCodecComponent
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of concrete
EPPIdnTableDomainLabel
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPIdnTableDomainLabel
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-