Package com.verisign.epp.codec.addlemail

Class EPPAddlEmail

java.lang.Object
com.verisign.epp.codec.addlemail.EPPAddlEmail
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPAddlEmail extends Object implements EPPCodecComponent
A second email can be set using the EPPEAIEmail extension with the option for defining the "primary" attribute to indicate that the extension email should be treated as the primary email address.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPEAIEmail.
    static final String
    ELM_NAME
    XML root tag for EPPEAIEmail.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPAddlEmail()
    Default constructor for EPPEAIEmail.
    EPPAddlEmail(String aEmail)
    Constructor for EPPEAIEmail that takes the second email value.
    EPPAddlEmail(String aEmail, boolean aPrimary)
    Constructor for EPPEAIEmail that takes the second email value.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    clone an EPPCodecComponent.
    void
    decode(Element aElement)
    decode a DOM element tree to initialize the instance attributes.
    Element
    encode(Document aDocument)
    encode instance into a DOM element tree.
    boolean
    equals(Object aObject)
    Compare an instance of EPPEAIEmail with this instance.
    String
    getEmail()
    Gets the second email value.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    boolean
    hasEmail()
    Is the second email defined?
    boolean
    isPrimary()
    Is the second email the primary email? The default value is false.
    void
    setEmail(String aEmail)
    Sets the second email value.
    void
    setPrimary(boolean aPrimary)
    Sets the primary attribute for the second email.
    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

    • EPPAddlEmail

      public EPPAddlEmail()
      Default constructor for EPPEAIEmail.

    • EPPAddlEmail

      public EPPAddlEmail(String aEmail)
      Constructor for EPPEAIEmail that takes the second email value.
      Parameters:
      aEmail - Second email. Set to null to explicitly indicate that there is no second email.

    • EPPAddlEmail

      public EPPAddlEmail(String aEmail, boolean aPrimary)
      Constructor for EPPEAIEmail that takes the second email value.
      Parameters:
      aEmail - Second email. Set to null to explicitly indicate that there is no second email.
      aPrimary - Is the second email the primary email?

  • Method Details

    • hasEmail

      public boolean hasEmail()
      Is the second email defined?
      Returns:
      true if the second email is defined; false otherwise.

    • getEmail

      public String getEmail()
      Gets the second email value.
      Returns:
      second email value if defined; null otherwise.

    • setEmail

      public void setEmail(String aEmail)
      Sets the second email value.
      Parameters:
      aEmail - Second email. Set to null to explicitly indicate that there is no second email.

    • isPrimary

      public boolean isPrimary()
      Is the second email the primary email? The default value is false.
      Returns:
      true if the second email is the primary email; false otherwise.

    • setPrimary

      public void setPrimary(boolean aPrimary)
      Sets the primary attribute for the second email.
      Parameters:
      aPrimary - Set to true if the second email is the primary email; false otherwise.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPEAIEmail

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • clone

      public Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPEAIEmail
      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.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPEAIEmail with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false 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.