public class EPPIdnTableCheckDomain extends java.lang.Object implements EPPCodecComponent
EPPIdnTableCheckDomain
is used to represent the
Internationalized Domain Name (IDN) information for a domain in a IDN table
response to a <check> command. The domain information includes whether
the domain is a valid IDN domain name, whether or not the use of the IDN
mapping extension is needed, and the matching list of valid IDN table
identifiers.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPIdnTableCheckDomain . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPIdnTableCheckDomain . |
Constructor and Description |
---|
EPPIdnTableCheckDomain()
Default constructor for
EPPIdnTableCheckDomain . |
EPPIdnTableCheckDomain(java.lang.String aName,
boolean aValid)
Constructor for
EPPIdnTableCheckDomain that takes the domain
name and whether the domain name is a valid IDN domain name. |
EPPIdnTableCheckDomain(java.lang.String aName,
boolean aValid,
boolean aIdnmap)
Constructor for
EPPIdnTableCheckDomain that takes the domain
name and whether the domain name is a valid IDN domain name, and whether
the domain name requires the IDN mapping extension with a domain create
of the domain name. |
EPPIdnTableCheckDomain(java.lang.String aDomain,
java.util.List<java.lang.String> aTables)
Constructor for
EPPIdnTableCheckDomain that is used for
valid IDN domain names by providing the list of IDN table identifiers. |
EPPIdnTableCheckDomain(java.lang.String aDomain,
java.lang.String aReason)
Constructor for
EPPIdnTableCheckDomain that is used for
invalid IDN domain names by providing the reason the domain name is not
valid. |
Modifier and Type | Method and Description |
---|---|
void |
addTable(java.lang.String aTable)
Append a table identifier to the list of table identifiers.
|
java.lang.Object |
clone()
clone an
EPPCodecComponent . |
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 of
EPPIdnTableCheckDomain with this
instance. |
java.lang.String |
getName()
Returns the domain name.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getReason()
Gets the reason that the domain name is invalid.
|
java.lang.String |
getReasonLang()
Gets the reason language value.
|
java.util.List<java.lang.String> |
getTables()
Get the list of table identifiers.
|
boolean |
hasReason()
Is the reason defined?
|
boolean |
hasReasonLang()
Is the reason language defined?
|
boolean |
hasTables()
Are any table identifiers defined in the list of table identifiers?
|
boolean |
isIdnmap()
Is the IDN mapping extension required on a domain create of the domain
name?
|
boolean |
isValid()
Is the domain name a valid IDN domain name?
|
void |
setIdnmap(boolean aIdnmap)
Set whether the IDN mapping extension is required on a domain create of
the domain name.
|
void |
setName(java.lang.String aDomain)
Sets the domain name.
|
void |
setReason(java.lang.String aReason)
Sets the reason that the domain name is invalid.
|
void |
setReasonLang(java.lang.String aReasonLang)
Sets the reason language value.
|
void |
setTable(java.lang.String aTable)
Set an individual table identifier.
|
void |
setTables(java.util.List<java.lang.String> aTables)
Set the list of table identifiers.
|
void |
setValid(boolean aValid)
Sets whether the domain name is a valid IDN domain name.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String ELM_LOCALNAME
EPPIdnTableCheckDomain
.public static final java.lang.String ELM_NAME
EPPIdnTableCheckDomain
.public EPPIdnTableCheckDomain()
EPPIdnTableCheckDomain
.public EPPIdnTableCheckDomain(java.lang.String aName, boolean aValid)
EPPIdnTableCheckDomain
that takes the domain
name and whether the domain name is a valid IDN domain name.aName
- Domain nameaValid
- Is the domain name a valid IDN domain name?public EPPIdnTableCheckDomain(java.lang.String aName, boolean aValid, boolean aIdnmap)
EPPIdnTableCheckDomain
that takes the domain
name and whether the domain name is a valid IDN domain name, and whether
the domain name requires the IDN mapping extension with a domain create
of the domain name.aName
- Domain nameaValid
- Is the domain name a valid IDN domain name?aIdnmap
- true
if the IDN mapping extension is required on a
domain create of the domain name; false
otherwise.public EPPIdnTableCheckDomain(java.lang.String aDomain, java.lang.String aReason)
EPPIdnTableCheckDomain
that is used for
invalid IDN domain names by providing the reason the domain name is not
valid.aDomain
- Domain nameaReason
- Reason that the IDN domain name is not valid.public EPPIdnTableCheckDomain(java.lang.String aDomain, java.util.List<java.lang.String> aTables)
EPPIdnTableCheckDomain
that is used for
valid IDN domain names by providing the list of IDN table identifiers.aDomain
- Domain nameaTables
- List of matching IDN table identifiers.public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aDomain)
aDomain
- Domain namepublic boolean isValid()
true
if it is a valid IDN domain name;
false
otherwise.public void setValid(boolean aValid)
aValid
- true
if the domain name is a valid IDN domain
name; false
otherwise.public boolean isIdnmap()
true
if the IDN mapping extension is required on a
domain create of the domain name; false
otherwise.public void setIdnmap(boolean aIdnmap)
aIdnmap
- true
if the IDN mapping extension is required on a
domain create of the domain name; false
otherwise.public boolean hasReason()
true
if the reason is defined; false
otherwise.public java.lang.String getReason()
null
otherwise.public void setReason(java.lang.String aReason)
aReason
- Reason that the domain is invalid. Set to null
to
clear the reason.public boolean hasReasonLang()
true
if the reason language is defined;
false
otherwise.public java.lang.String getReasonLang()
null
otherwise.public void setReasonLang(java.lang.String aReasonLang)
aReasonLang
- Reason language for reason value.public boolean hasTables()
true
if there is at least one table identifier
defined; false
otherwise.public java.util.List<java.lang.String> getTables()
List
of table identifier String
'spublic void setTables(java.util.List<java.lang.String> aTables)
aTables
- List
of table identifier String
'spublic void setTable(java.lang.String aTable)
aTable
- Table identifierpublic void addTable(java.lang.String aTable)
aTable
- Table identifierpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- DOM Document, which acts is an Element factoryEPPEncodeException
- Error encoding EPPIdnTableCheckDomain
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
aElement
argument represents the root DOM element and is
used to traverse the DOM nodes for instance attribute values.decode
in interface EPPCodecComponent
aElement
- Element
to decodeEPPDecodeException
- Error decoding Element
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPIdnTableCheckDomain
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public boolean equals(java.lang.Object aObject)
EPPIdnTableCheckDomain
with this
instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if equal; false
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.