Package com.verisign.epp.codec.registry
Class EPPRegistryCustomData
- java.lang.Object
-
- com.verisign.epp.codec.registry.EPPRegistryCustomData
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPRegistryCustomData extends java.lang.Object implements EPPCodecComponent
Represents custom data using key/value pairs. The <registry:customeData> element contains the following child elements:- <registry:value> - one or more elements with a required "key"
attribute, which defines the key for the value. Use
getKeyValues()
andsetKeyValues(List)
to get and set the elements. UseaddKeyValue(EPPRegistryKeyValue)
to add one key/value pair to existingList
.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_NAME
XML Element Name ofEPPRegistryCustomData
root element.
-
Constructor Summary
Constructors Constructor Description EPPRegistryCustomData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addKeyValue(EPPRegistryKeyValue keyValue)
Add one key/value pair to existing key/value pairs.java.lang.Object
clone()
CloneEPPRegistryCustomData
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPRegistryCustomData
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 theEPPRegistryCustomData
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPRegistryCustomData
compare.java.util.List
getKeyValues()
Get the custom key/value pairs.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.void
setKeyValues(java.util.List keyValues)
Set the custom key/value pairs.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML Element Name ofEPPRegistryCustomData
root element.- See Also:
- Constant Field Values
-
-
Method Detail
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPRegistryCustomData
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPRegistryCustomData
instance. - Throws:
EPPEncodeException
- - Unable to encodeEPPRegistryCustomData
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPRegistryCustomData
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPRegistryCustomData
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPRegistryCustomData
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPRegistryCustomData
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPRegistryCustomData
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPRegistryCustomData
instance to compare with- Returns:
true
if this object is the same as the aObject argument;false
otherwise
-
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.
-
getKeyValues
public java.util.List getKeyValues()
Get the custom key/value pairs.- Returns:
List
of key/value pair, instance ofEPPRegistryKeyValue
-
setKeyValues
public void setKeyValues(java.util.List keyValues)
Set the custom key/value pairs.- Parameters:
keyValues
-List
of key/value pair, instance ofEPPRegistryKeyValue
-
addKeyValue
public void addKeyValue(EPPRegistryKeyValue keyValue)
Add one key/value pair to existing key/value pairs.- Parameters:
keyValue
- key/value pair
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-