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

Class EPPRegistryReservedNames

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryReservedNames
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryReservedNames extends Object implements EPPCodecComponent
EPPRegistryReservedNames defines the set of reserved domain names starting from that label level. The reserved names can refer to values with more than one level which is relative to the level of the parent <registry:domainName> element.
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryReservedNames

      public EPPRegistryReservedNames()
      Default constructor.

    • EPPRegistryReservedNames

      public EPPRegistryReservedNames(List<String> aReservedNames)
      EPPRegistryReservedNames constructor that takes the list of reserved names.
      Parameters:
      aReservedNames - List of reserved names relative to the level of the zone.

    • EPPRegistryReservedNames

      public EPPRegistryReservedNames(String aReservedNameURI)
      EPPRegistryReservedNames constructor that takes the external reserved name URI.
      Parameters:
      aReservedNameURI - URI to an externally defined list of reserved domain names relative to the level of the zone. Set to null to clear the URI.

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPRegistryReservedNames 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 EPPRegistryReservedNames instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPRegistryReservedNames instance.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPRegistryReservedNames attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPRegistryReservedNames from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryReservedNames compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryReservedNames 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 EPPRegistryZoneInfo.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPRegistryZoneInfo
      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.

    • hasReservedNames

      public boolean hasReservedNames()
      Is the reserved name list defined?
      Returns:
      true if the reserved name list is defined; false otherwise.

    • getReservedNames

      public List<String> getReservedNames()
      Gets the reserved names.
      Returns:
      Reserved names if defined; null otherwise.

    • setReservedNames

      public void setReservedNames(List<String> aReservedNames)
      Sets the reserved names.
      Parameters:
      aReservedNames - List of reserved names relative to the zone.

    • addReservedName

      public void addReservedName(String aReservedName)
      Add a reserved name relative to the zone to the list of reserved names.
      Parameters:
      aReservedName - Reserved name to add to the list of reserved names.

    • hasReservedNameURI

      public boolean hasReservedNameURI()
      Is the reserved name URI defined?
      Returns:
      true if the reserved name URI is defined; false otherwise.

    • getReservedNameURI

      public String getReservedNameURI()
      Gets the URI to an externally defined list of reserved domain names relative to the level of the zone.
      Returns:
      URI to an externally defined list of reserved domain names relative to the level of the zone if defined; null otherwise.

    • setReservedNameURI

      public void setReservedNameURI(String aReservedNameURI)
      Sets the URI to an externally defined list of reserved domain names relative to the level of the zone.
      Parameters:
      aReservedNameURI - URI to an externally defined list of reserved domain names relative to the level of the zone. Set to null to clear the URI.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.