public class EPPValue extends java.lang.Object implements EPPCodecComponent
String
value
needs to be set using XML with the specified namespace prefix. For example,
the URI could be "urn:ietf:params:xml:ns:domain-1.0", the prefix could be
"domain", and the value could be
<domain:name>example.com</domain:name>.EPPResult
,
Serialized FormConstructor and Description |
---|
EPPValue()
Default constructor for serialization.
|
EPPValue(java.lang.String aValue)
Allocates a new
EPPValue with only the String
value. |
EPPValue(java.lang.String aValue,
java.lang.String aPrefix,
java.lang.String aNamespace)
Allocates a new
EPPValue with all attribute values. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPValue . |
void |
decode(org.w3c.dom.Element aElement)
decode
EPPValue from a DOM element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode
EPPValue into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPValue compare. |
java.lang.String |
getNamespace()
Gets the XML namespace URI of the client element.
|
java.lang.String |
getPrefix()
Gets the XML prefix of the client element.
|
java.lang.String |
getValue()
Gets XML
String that identifies a client-provided element
(including XML tag and value) that caused a server error. |
void |
setNamespace(java.lang.String aNamespace)
Sets the XML namespace URI of the client element.
|
void |
setPrefix(java.lang.String aPrefix)
Sets the XML prefix of the client element.
|
void |
setValue(java.lang.String aValue)
Sets XML
String that identifies a client-provided element
(including XML tag and value) that caused a server error. |
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public EPPValue()
value
attribute
must be set before calling encode
.public EPPValue(java.lang.String aValue)
EPPValue
with only the String
value. The prefix is set to null
and the namespace is to the
"urn:ietf:params:xml:ns:epp-1.0".aValue
- XML String
that identifies a client-provided
element (including XML tag and value) that caused a server
error.public EPPValue(java.lang.String aValue, java.lang.String aPrefix, java.lang.String aNamespace)
EPPValue
with all attribute values.aValue
- XML String
that identifies a client-provided
element (including XML tag and value) that caused a server
error. For example,
<domain:name>example.com</domain:name>.aPrefix
- XML Namespace prefix. For example, "domain". Set to null
for no namespace prefix.aNamespace
- XML Namespace URI. For example,
"urn:ietf:params:xml:ns:domain-1.0". If set to null
the
default of "urn:ietf:params:xml:ns:epp-1.0" is used.public java.lang.String getValue()
String
that identifies a client-provided element
(including XML tag and value) that caused a server error.String
value using namespace prefix.public void setValue(java.lang.String aValue)
String
that identifies a client-provided element
(including XML tag and value) that caused a server error.aValue
- XML String
that identifies a client-provided
element (including XML tag and value) that caused a server
error. For example,
<domain:name>example.com</domain:name>.public java.lang.String getPrefix()
null
otherwise.public void setPrefix(java.lang.String aPrefix)
aPrefix
- XML prefix to predefine in the <value> element. Set to
null
to not predefine a namespace prefix.public java.lang.String getNamespace()
getNamespace
in interface EPPCodecComponent
null
otherwise.public void setNamespace(java.lang.String aNamespace)
aNamespace
- ML namespace URI to predefine in the <value> element. Set
to null
to not predefine a namespace.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPValue
into a DOM element tree.encode
in interface EPPCodecComponent
aDocument
- DOM DocumentEPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPValue
from a DOM element tree. The
aElement
argument needs to be the "extValue" element.decode
in interface EPPCodecComponent
aElement
- The "extValue" XML element.EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPValue
compare.equals
in class java.lang.Object
aObject
- EPPValue
instance to compare withtrue
if equal; false
otherwisepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPValue
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPValue
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.