public class EPPRegistryRegex extends java.lang.Object implements EPPCodecComponent
EPPRegistryRegex
represents a general regular expression that
includes both the expression and an optional description. Since this is a
generic regular expression EPPCodecComponent
, used by multiple
parent EPPCodecComponent
's, the root element must be set using
the setRootName(String)
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_LANG
Language attribute of the explanation element.
|
static java.lang.String |
ELM_DESCRIPTION
Regular expression optional description element label.
|
static java.lang.String |
ELM_EXPRESSION
Regular expression element label.
|
Constructor and Description |
---|
EPPRegistryRegex()
Default constructor for
EPPRegistryRegex . |
EPPRegistryRegex(java.lang.String aExpression)
Constructor that takes the required regular expression value.
|
EPPRegistryRegex(java.lang.String aExpression,
java.lang.String aDescription)
Constructor that takes the required regular expression value along with
the optional explanation.
|
EPPRegistryRegex(java.lang.String aExpression,
java.lang.String aDescription,
java.lang.String aLang)
Constructor that takes the required regular expression value along with
the optional explanation and the language of the explanation.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPRegistryRegex . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPRegistryRegex attributes from the aElement DOM
Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the
EPPRegistryRegex instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPRegistryRegex compare. |
java.lang.String |
getDescription()
Gets the description of the regular expression.
|
java.lang.String |
getExpression()
Gets the regular expression value.
|
java.lang.String |
getLang()
Gets the language of the explanation.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
boolean |
hasDescription()
Has description?
|
void |
setDescription(java.lang.String aDescription)
Sets the description of the regular expression.
|
void |
setExpression(java.lang.String aExpression)
Sets the regular expression value.
|
void |
setLang(java.lang.String aLang)
Sets the language of the explanation.
|
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_EXPRESSION
public static final java.lang.String ELM_DESCRIPTION
public static final java.lang.String ATTR_LANG
public EPPRegistryRegex()
EPPRegistryRegex
.public EPPRegistryRegex(java.lang.String aExpression)
aExpression
- Regular expression value.public EPPRegistryRegex(java.lang.String aExpression, java.lang.String aDescription)
aExpression
- Regular expression value.aDescription
- Description of the regular expression.public EPPRegistryRegex(java.lang.String aExpression, java.lang.String aDescription, java.lang.String aLang)
aExpression
- Regular expression value.aDescription
- Description of the regular expression.aLang
- Language of the explanation.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryRegex
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPRegistryRegex
instance.EPPEncodeException
- Unable to encode EPPRegistryRegex
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryRegex
attributes from the aElement DOM
Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPRegistryRegex
from.EPPDecodeException
- Unable to decode aElement.public 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 java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryRegex
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRegistryRegex
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean equals(java.lang.Object aObject)
EPPRegistryRegex
compare.equals
in class java.lang.Object
aObject
- EPPRegistryRegex
instance to compare withpublic java.lang.String getExpression()
null
otherwise.public void setExpression(java.lang.String aExpression)
aExpression
- Regular expression value.public boolean hasDescription()
true
if the description is defined; false
otherwise.public java.lang.String getDescription()
null
otherwise.public void setDescription(java.lang.String aDescription)
aDescription
- Regular expression description.public java.lang.String getLang()
null
otherwise.public void setLang(java.lang.String aLang)
aLang
- Language of the explanation.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.