Package com.verisign.epp.codec.registry

Class EPPRegistryCustomData

java.lang.Object

com.verisign.epp.codec.registry.EPPRegistryCustomData

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPRegistryCustomData
extends 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() and setKeyValues(List) to get and set the elements. Use addKeyValue(EPPRegistryKeyValue) to add one key/value pair to existing List.

See Also:

• EPPRegistryDomain
• EPPRegistryHost
• EPPRegistryContact
• EPPRegistryKeyValue
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_NAME	XML Element Name of EPPRegistryCustomData root element.

Constructor Summary

Constructors

Constructor	Description
EPPRegistryCustomData()

Method Summary

Modifier and Type	Method	Description
void	addKeyValue(EPPRegistryKeyValue keyValue)	Add one key/value pair to existing key/value pairs.
Object	clone()	Clone EPPRegistryCustomData.
void	decode(Element aElement)	Decode the EPPRegistryCustomData attributes from the aElement DOM Element tree.
Element	encode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPRegistryCustomData instance.
boolean	equals(Object aObject)	implements a deep EPPRegistryCustomData compare.
List	getKeyValues()	Get the custom key/value pairs.
String	getNamespace()	Returns the XML namespace associated with the EPPCodecComponent.
void	setKeyValues(List keyValues)	Set the custom key/value pairs.
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 Details

ELM_NAME

public static final String ELM_NAME

XML Element Name of EPPRegistryCustomData root element.

See Also:

• Constant Field Values

Constructor Details

EPPRegistryCustomData

public EPPRegistryCustomData()

Method Details

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPRegistryCustomData instance.

Specified by:

encode in interface EPPCodecComponent

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 encode EPPRegistryCustomData instance.

decode

public void decode(Element aElement)
            throws EPPDecodeException

Decode the EPPRegistryCustomData attributes from the aElement DOM Element tree.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - Root DOM Element to decode EPPRegistryCustomData from.

Throws:

EPPDecodeException - Unable to decode aElement

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPRegistryCustomData.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class Object

Returns:

clone of EPPRegistryCustomData

Throws:

CloneNotSupportedException - standard Object.clone exception

equals

public boolean equals(Object aObject)

implements a deep EPPRegistryCustomData compare.

Overrides:

equals in class Object

Parameters:

aObject - EPPRegistryCustomData instance to compare with

Returns:

true if this object is the same as the aObject argument; false otherwise

toString

public String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class Object

Returns:

Indented XML String if successful; ERROR otherwise.

getKeyValues

public List getKeyValues()

Get the custom key/value pairs.

Returns:

List of key/value pair, instance of EPPRegistryKeyValue

setKeyValues

public void setKeyValues(List keyValues)

Set the custom key/value pairs.

Parameters:

keyValues - List of key/value pair, instance of EPPRegistryKeyValue

addKeyValue

public void addKeyValue(EPPRegistryKeyValue keyValue)

Add one key/value pair to existing key/value pairs.

Parameters:

keyValue - key/value pair

getNamespace

public String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.