Package com.verisign.epp.codec.relateddomainext

Class EPPRelatedDomainExtDelete

java.lang.Object
com.verisign.epp.codec.relateddomainext.EPPRelatedDomainExtDelete
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRelatedDomainExtDelete extends Object implements EPPCodecComponent
EPPCodecComponent that encodes and decodes a <relDom:delete> tag associated with a Domain-Delete command.

Title: EPP 1.0 Related Domain - delete tag

Description: The EPPRelatedDomainExtDelete object represents the collection of domains that must be deleted atomically. As such it is composed of a collection of String objects.
As XML, it is represented by a <relDom:delete> element containing a number of <relDom:name> elements.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_DOMAIN_NAME
     
    static final String
    ELM_NAME
    Element tag name for create

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPRelatedDomainExtDelete()
    Default constructor
    EPPRelatedDomainExtDelete(List<String> aDomains)
    Constructor with a list of domain names to be deleted.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addDomain(String aDomainName)
    Adds a domain name to be deleted to the list.
    Object
    clone()
    A deep clone of the EPPRelatedDomainExtDelete
    void
    decode(Element aElement)
    Populate the data of this instance with the data stored in the given Element of the DOM tree
    Element
    encode(Document aDocument)
    Append all data from the list related domain names to be deleted to given DOM Document
    boolean
    equals(Object aObj)
    A deep comparison of this with another EPPRelatedDomainExtDelete.
    List<String>
    getDomains()
    Returns the list of related domain names to be deleted
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    boolean
    hasDomains()
    Are there any domains included in the list of domains?
    void
    setDomains(List<String> aDomains)
    Sets the list of related domain names to be deleted
    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

  • Constructor Details

    • EPPRelatedDomainExtDelete

      public EPPRelatedDomainExtDelete()
      Default constructor

    • EPPRelatedDomainExtDelete

      public EPPRelatedDomainExtDelete(List<String> aDomains)
      Constructor with a list of domain names to be deleted.
      Parameters:
      aDomains - List of domain names to be deleted

  • Method Details

    • clone

      public Object clone() throws CloneNotSupportedException
      A deep clone of the EPPRelatedDomainExtDelete
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPCodecComponent
      Throws:
      CloneNotSupportedException - standard Object.clone exception
      See Also:

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Populate the data of this instance with the data stored in the given Element of the DOM tree
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - The root element of the report fragment of XML
      Throws:
      EPPDecodeException - Thrown if any errors occur during decoding.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Append all data from the list related domain names to be deleted to given DOM Document
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - The DOM Document to append data to
      Returns:
      Encoded DOM Element
      Throws:
      EPPEncodeException - Thrown when errors occur during the encode attempt or if the instance is invalid.

    • equals

      public boolean equals(Object aObj)
      A deep comparison of this with another EPPRelatedDomainExtDelete.
      Overrides:
      equals in class Object
      See Also:

    • addDomain

      public void addDomain(String aDomainName)
      Adds a domain name to be deleted to the list.
      Parameters:
      aDomainName - Related domain name to add to the list.

    • hasDomains

      public boolean hasDomains()
      Are there any domains included in the list of domains?
      Returns:
      true if the domain list is not null and there is at least one domain in the list; false otherwise.

    • getDomains

      public List<String> getDomains()
      Returns the list of related domain names to be deleted
      Returns:
      the relatedDomains

    • setDomains

      public void setDomains(List<String> aDomains)
      Sets the list of related domain names to be deleted
      Parameters:
      aDomains - the relatedDomains to set

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

    • getNamespace

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