com.neulevel.epp.xri
Class EppXriSynonym

java.lang.Object
  com.neulevel.epp.core.EppEntity
      com.neulevel.epp.xri.EppXriSynonym

public class EppXriSynonym
extends EppEntity

This EppXriSynonym class defines a synonym element with a priority attribute. Elements such as LocalID and EquivID are represented with this class. It implements XRI synonymAddType and synonymInfType defined in the XRI authority schema file.

Version:

$Revision: 1.1 $ $Date: 2008/03/21 00:39:00 $

Author:

Ning Zhang ning.zhang@neustar.com

Constructor Summary

EppXriSynonym()
Creates an EppXriSynonym object

EppXriSynonym(java.lang.String synonym)
Creates an EppXriSynonym object with an Synonym.

EppXriSynonym(java.lang.String synonym, int priority)
Creates an EppXriSynonym object with a Synonym and a priority value

Method Summary

static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppXriSynonym object.
int	getPriority() Gets the priority value for this Synonym.
java.lang.String	getSynonym() Gets the XRI string of this Synonym
void	setPriority(int priority) Sets the priority value for this Synonym.
void	setSynonym(java.lang.String synonym) Sets the XRI string of this Synonym
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppXriSynonym object into an XML element

Methods inherited from class com.neulevel.epp.core.EppEntity

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EppXriSynonym

public EppXriSynonym()

Creates an EppXriSynonym object

EppXriSynonym

public EppXriSynonym(java.lang.String synonym)

Creates an EppXriSynonym object with an Synonym.

EppXriSynonym

public EppXriSynonym(java.lang.String synonym,
                     int priority)

Creates an EppXriSynonym object with a Synonym and a priority value

Method Detail

getPriority

public int getPriority()

Gets the priority value for this Synonym. A value of -1 indicates null priority.

setPriority

public void setPriority(int priority)

Sets the priority value for this Synonym. Use -1 to set it to null.

getSynonym

public java.lang.String getSynonym()

Gets the XRI string of this Synonym

setSynonym

public void setSynonym(java.lang.String synonym)

Sets the XRI string of this Synonym

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)

Converts the EppXriSynonym object into an XML element

Specified by:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppXriSynonym object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)

Converts an XML element into an EppXriSynonym object. The caller of this method must make sure that the root node is of the EPP XRI synonymAddType or synonymInfType.

Parameters:

root - root node for an EppXriSynonym object in XML format

Returns:

an EppXriSynonym object, or null if the node is invalid

toString

public java.lang.String toString()

Specified by:

toString in class EppEntity