|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPValue
public class EPPValue
Identifies a client-provided element (including XML tag and value) that
caused a server error condition. The value includes a reference to the
namespace URI and namespace prefix for encoding the value. The
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>. The default
namespace prefix is "epp" and the default URI is
"urn:ietf:params:xml:ns:epp-1.0".
EPPResult
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
DEFAULT_NS
Default namespace |
static java.lang.String |
DEFAULT_PREFIX
Default namespace prefix |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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 . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_PREFIX
public static final java.lang.String DEFAULT_NS
Constructor Detail |
---|
public EPPValue()
value
attribute
must be set before calling encode
.
public EPPValue(java.lang.String aValue)
EPPValue
with only the String
value. The prefix and namespace to DEFAULT_PREFIX
and
DEFAULT_NS
respectively.
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>.aPrefix
- XML Namespace prefix. For example, "domain" or "epp".aNamespace
- XML Namespace URI. For example,
"urn:ietf:params:xml:ns:domain-1.0".Method Detail |
---|
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>.public java.lang.String getPrefix()
String
public void setPrefix(java.lang.String aPrefix)
aPrefix
- XML prefix String
public java.lang.String getNamespace()
String
public void setNamespace(java.lang.String aNamespace)
aNamespace
- XML namespace URI String
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPValue
into a DOM element tree.
encode
in interface EPPCodecComponent
aDocument
- DOCUMENT ME!
EPPEncodeException
- 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 with
true
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |