com.verisign.epp.codec.suggestion
Class EPPSuggestionTld

java.lang.Object
  com.verisign.epp.codec.suggestion.EPPSuggestionTld

All Implemented Interfaces:

EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

public class EPPSuggestionTld
extends java.lang.Object
implements EPPCodecComponent

A Tld object encapsulates a Top Level Domain. This element allows the client to specify the Top Level Domains to use during suggestions creation.

Author:

jcolosi

See Also:

Serialized Form

Constructor Summary

EPPSuggestionTld()
Constructor.

EPPSuggestionTld(org.w3c.dom.Element aElement)
Constructor.

EPPSuggestionTld(java.lang.String aTld)
Constructor.

Method Summary

java.lang.Object	clone() clone an EPPCodecComponent.
void	decode(org.w3c.dom.Element aElement) decode a DOM element tree to initialize the instance attributes.
org.w3c.dom.Element	encode(org.w3c.dom.Document aDocument) encode instance into a DOM element tree.
boolean	equals(java.lang.Object o)
java.lang.String	getTld() Tld getter.
void	setTld(java.lang.String aTld) Tld setter.
java.lang.String	toLogString() A string representation for logging purpose.
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

Constructor Detail

EPPSuggestionTld

public EPPSuggestionTld()

Constructor.

EPPSuggestionTld

public EPPSuggestionTld(org.w3c.dom.Element aElement)
                 throws InvalidValueException

Constructor.

Parameters:

aElement - a dom element

Throws:

InvalidValueException

EPPSuggestionTld

public EPPSuggestionTld(java.lang.String aTld)

Constructor.

Parameters:

aTld - a tld

Method Detail

getTld

public java.lang.String getTld()

Tld getter.

Returns:

a tld

setTld

public void setTld(java.lang.String aTld)

Tld setter.

Parameters:

aTld - a tld

toLogString

public java.lang.String toLogString()

A string representation for logging purpose.

Returns:

a string

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

Indented XML String if successful; ERROR otherwise.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: EPPCodecComponent

clone an EPPCodecComponent.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class java.lang.Object

Returns:

clone of concrete EPPCodecComponent

Throws:

java.lang.CloneNotSupportedException - standard Object.clone exception

decode

public void decode(org.w3c.dom.Element aElement)
            throws InvalidValueException

Description copied from interface: EPPCodecComponent

decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.

For example, the <command> element of EPPCommand is passed into decode of EPPCommand to be decoded and used to set the instance attributes.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - root DOM element associated with instance

Throws:

InvalidValueException

encode

public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument)
                           throws EPPEncodeException

Description copied from interface: EPPCodecComponent

encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.

For example, the <command> element of EPPCommand is created and is used to append the attribute nodes of EPPCommand.

Specified by:

encode in interface EPPCodecComponent

Parameters:

aDocument - DOM document used as a factory of DOM objects.

Returns:

instance root DOM element along with attribute child nodes.

Throws:

EPPEncodeException - Error encoding the DOM element tree.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object