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

Class EPPRegistryServices.EPPRegistryURI

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryServices.EPPRegistryURI
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
Direct Known Subclasses:
EPPRegistryServices.EPPRegistryObjURI, EPPRegistryServicesExt.EPPRegistryExtURI
Enclosing class:
EPPRegistryServices
public abstract static class EPPRegistryServices.EPPRegistryURI extends Object implements EPPCodecComponent
Abstract class that represents an object or extension URI.
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryURI

      public EPPRegistryURI()
      Default constructor. The "required" attribute must be set and the URI must be set prior to calling encode(Document).

    • EPPRegistryURI

      public EPPRegistryURI(String aUri, Boolean aRequired)
      Constructor that takes the two required attributes for the URI and the required attribute.
      Parameters:
      aUri - The object or extension URI
      aRequired - true if the use of the object or extension URI is required; false otherwise.

  • Method Details

    • getRootName

      public abstract String getRootName()
      Gets the name of the root XML element.
      Returns:
      ELM_OBJ_URI for an object URI and ELM_EXT_URI for an extension URI.

    • encode

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

    • decode

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPRegistryURI.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPRegistryURI
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryURI compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryURI instance to compare with
      Returns:
      true if this object is the same as the aObject argument; false otherwise

    • 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.

    • getRequired

      public Boolean getRequired()
      Gets the "required" attribute value.
      Returns:
      true if use of the URI is required; false otherwise. null if the attribute has not been set.

    • setRequired

      public void setRequired(Boolean aRequired)
      Sets the "required" attribute value.
      Parameters:
      aRequired - true if use of the URI is required; false otherwise.

    • getUri

      public String getUri()
      Gets the object or extension URI.
      Returns:
      Object or extension URI if defined; null otherwise.

    • setUri

      public void setUri(String aUri)
      Sets the object or extension URI.
      Parameters:
      aUri - Object or extension URI value.