com.verisign.epp.codec.suggestion
Class EPPSuggestionToken

java.lang.Object
  extended by com.verisign.epp.codec.suggestion.EPPSuggestionToken
All Implemented Interfaces:
EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

public class EPPSuggestionToken
extends java.lang.Object
implements EPPCodecComponent

A Token describes a part of the <suggestion:key> element which has been seperated by the Suggestions server. This information is optionally returned by the server.

Author:
jcolosi
See Also:
Serialized Form

Constructor Summary
EPPSuggestionToken()
          Constructor.
EPPSuggestionToken(org.w3c.dom.Element aElement)
          Constructor.
EPPSuggestionToken(java.lang.String aName)
          Constructor.
 
Method Summary
 void addRelated(EPPSuggestionRelated aRelated)
          Add related value.
 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 getName()
          Name getter.
 java.util.List<EPPSuggestionRelated> getRelatedList()
          Related list getter.
 void resetRelatedList()
          Reset the related list.
 void setName(java.lang.String aName)
          Name setter.
 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

EPPSuggestionToken

public EPPSuggestionToken()
Constructor.


EPPSuggestionToken

public EPPSuggestionToken(java.lang.String aName)
Constructor.

Parameters:
aName - a name

EPPSuggestionToken

public EPPSuggestionToken(org.w3c.dom.Element aElement)
                   throws EPPDecodeException
Constructor.

Parameters:
aElement - a dom element
Throws:
EPPDecodeException
Method Detail

getName

public java.lang.String getName()
Name getter.

Returns:
a name.

getRelatedList

public java.util.List<EPPSuggestionRelated> getRelatedList()
Related list getter.

Returns:
a related list

setName

public void setName(java.lang.String aName)
Name setter.

Parameters:
aName - a name

addRelated

public void addRelated(EPPSuggestionRelated aRelated)
                throws InvalidValueException
Add related value.

Parameters:
aRelated - a related value
Throws:
InvalidValueException

resetRelatedList

public void resetRelatedList()
Reset the related list.


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 EPPDecodeException
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:
EPPDecodeException - Error decoding the DOM element tree.

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


Copyright © VeriSign Inc. All Rights Reserved.