Package com.verisign.epp.codec.statusset.v02

Class EPPStatusSetAttribute

java.lang.Object
com.verisign.epp.codec.statusset.v02.EPPStatusSetAttribute
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPStatusSetAttribute extends Object implements EPPCodecComponent
Contains a status set attribute that includes a name and a value. The value can be empty for returning the supported attribute names.
See Also:

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPStatusSetAttribute()
    Default constructor for EPPStatusSetAttribute.
    EPPStatusSetAttribute(String aName)
    Constructor for EPPStatusSetAttribute that takes the required attribute name.
    EPPStatusSetAttribute(String aName, String aValue)
    Constructor for EPPStatusSetAttribute that takes the required attribute name and the optional attribute 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 EPPStatusSetAttribute with this instance.
    String
    getName()
    Gets the status set attribute name.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getValue()
    Gets the status set attribute value.
    boolean
    hasName()
    Is the status set attribute name defined?
    boolean
    hasValue()
    Is the status set attribute value defined?
    void
    setName(String aName)
    Sets the status set attribute name.
    void
    setValue(String aValue)
    Sets the status set attribute value.
    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_LOCALNAME

      public static final String ELM_LOCALNAME
      XML local name for EPPStatusSetInfo.
      See Also:

    • ELM_NAME

      public static String ELM_NAME
      XML root tag for EPPStatusSetAttribute.

  • Constructor Details

    • EPPStatusSetAttribute

      public EPPStatusSetAttribute()
      Default constructor for EPPStatusSetAttribute.

    • EPPStatusSetAttribute

      public EPPStatusSetAttribute(String aName)
      Constructor for EPPStatusSetAttribute that takes the required attribute name.
      Parameters:
      aName - Name of the attribute

    • EPPStatusSetAttribute

      public EPPStatusSetAttribute(String aName, String aValue)
      Constructor for EPPStatusSetAttribute that takes the required attribute name and the optional attribute value.
      Parameters:
      aName - Name of the attribute
      aValue - Value of the attribute. The value can be set to null.

  • Method Details

    • hasName

      public boolean hasName()
      Is the status set attribute name defined?
      Returns:
      true if the status set attribute name is defined; false otherwise.

    • getName

      public String getName()
      Gets the status set attribute name.
      Returns:
      Status set attribute name if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the status set attribute name.
      Parameters:
      aName - The status set attribute name to set

    • hasValue

      public boolean hasValue()
      Is the status set attribute value defined?
      Returns:
      true if the status set attribute value is defined; false otherwise.

    • getValue

      public String getValue()
      Gets the status set attribute value.
      Returns:
      Status set attribute value if defined; null otherwise.

    • setValue

      public void setValue(String aValue)
      Sets the status set attribute value.
      Parameters:
      aValue - The status set attribute value to set

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

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