Package com.verisign.epp.codec.registry.v02

Class EPPRegistryZoneName

java.lang.Object

com.verisign.epp.codec.registry.v02.EPPRegistryZoneName

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPRegistryZoneName
extends Object
implements EPPCodecComponent

The zone name is an element that includes an optional "form" attribute that defines the form of the zone name as either "aLabel" or "uLabel", with the default value of "aLabel". The "aLabel" form of a zone name contains all ASCII name labels that conform to [RFC0952] and [RFC1123]. The "uLabel" form of a zone name that includes one or more non-ASCII name labels that can be represented as ASCII labels using [RFC5890].

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EPPRegistryZoneName.Form	Possible values for the form attribute.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_FORM	XML attribute name for the form attribute.
static final String	ELM_ZONE	Optional XML Element Name of name attribute.
static final String	ELM_ZONE_NAME	Default XML Element Name for name attribute.

Constructor Summary

Constructors

Constructor	Description
EPPRegistryZoneName()	Default constructor.
EPPRegistryZoneName(String aName)	Construct EPPRegistryZoneName with name using the default root label of ELM_ZONE_NAME and the default form of EPPRegistryZoneName.Form.aLabel.
EPPRegistryZoneName(String aName, EPPRegistryZoneName.Form aForm)	Construct EPPRegistryZoneName with name and form using the default root label of ELM_ZONE_NAME.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPRegistryZone.
void	decode(Element aElement)	Decode the EPPRegistryZone attributes from the aElement DOM Element tree.
Element	encode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPRegistryZone instance.
boolean	equals(Object aObject)	implements a deep EPPRegistryZone compare.
EPPRegistryZoneName.Form	getForm()	Gets the form of the zone name.
String	getName()	Gets the name of the zone.
String	getNamespace()	Returns the XML namespace associated with the EPPCodecComponent.
String	getRootName()	Gets the root element local name, which should be either ELM_ZONE_NAME or ELM_ZONE.
void	setForm(EPPRegistryZoneName.Form aForm)	Sets the form of the zone name.
void	setName(String aName)	Sets the name of the zone.
void	setRootName(String aRootName)	Sets the root element local name, which should be either ELM_ZONE_NAME or ELM_ZONE.
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_ZONE_NAME

public static final String ELM_ZONE_NAME

Default XML Element Name for name attribute.

See Also:

• Constant Field Values

ELM_ZONE

public static final String ELM_ZONE

Optional XML Element Name of name attribute.

See Also:

• Constant Field Values

ATTR_FORM

public static final String ATTR_FORM

XML attribute name for the form attribute.

See Also:

• Constant Field Values

Constructor Details

EPPRegistryZoneName

public EPPRegistryZoneName()

Default constructor. Attributes are set to:

• elmRootLocalName - ELM_ZONE_NAME
• name - null
• form - EPPRegistryZoneName.Form.aLabel

Use setName(String) before calling encode(Document)

EPPRegistryZoneName

public EPPRegistryZoneName(String aName)

Construct EPPRegistryZoneName with name using the default root label of ELM_ZONE_NAME and the default form of EPPRegistryZoneName.Form.aLabel.

Parameters:

aName - fully qualified name of zone object

EPPRegistryZoneName

public EPPRegistryZoneName(String aName,
 EPPRegistryZoneName.Form aForm)

Construct EPPRegistryZoneName with name and form using the default root label of ELM_ZONE_NAME.

Parameters:

aName - fully qualified name of zone object

aForm - The form of the zone name as either EPPRegistryZoneName.Form.aLabel or EPPRegistryZoneName.Form.uLabel,

Method Details

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPRegistryZone 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 EPPRegistryZone instance.

Throws:

EPPEncodeException - - Unable to encode EPPRegistryZone instance.

decode

public void decode(Element aElement)
            throws EPPDecodeException

Decode the EPPRegistryZone attributes from the aElement DOM Element tree.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - Root DOM Element to decode EPPRegistryZone from.

Throws:

EPPDecodeException - Unable to decode aElement

equals

public boolean equals(Object aObject)

implements a deep EPPRegistryZone compare.

Overrides:

equals in class Object

Parameters:

aObject - EPPRegistryZone instance to compare with

Returns:

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

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPRegistryZone.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class Object

Returns:

clone of EPPRegistryZone

Throws:

CloneNotSupportedException - standard Object.clone exception

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.

getRootName

public String getRootName()

Gets the root element local name, which should be either ELM_ZONE_NAME or ELM_ZONE.

Returns:

ELM_ZONE_NAME or ELM_ZONE

setRootName

public void setRootName(String aRootName)

Sets the root element local name, which should be either ELM_ZONE_NAME or ELM_ZONE.

Parameters:

aRootName - ELM_ZONE_NAME or ELM_ZONE

getName

public String getName()

Gets the name of the zone.

Returns:

fully qualified name of the zone object

setName

public void setName(String aName)

Sets the name of the zone.

Parameters:

aName - fully qualified name of the zone object

getForm

public EPPRegistryZoneName.Form getForm()

Gets the form of the zone name.

Returns:

Form of the zone name with the default of EPPRegistryZoneName.Form.aLabel.

setForm

public void setForm(EPPRegistryZoneName.Form aForm)

Sets the form of the zone name.

Parameters:

aForm - Form of the zone name.

getNamespace

public String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.