Package com.verisign.epp.codec.maintenance.v1_0

Class EPPMaintenanceType

java.lang.Object
com.verisign.epp.codec.maintenance.v1_0.EPPMaintenanceType
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPMaintenanceType extends Object implements EPPCodecComponent
Type of the maintenance that has the possible set of values defined by server policy, such as "Routine Maintenance", "Software Update", "Software Upgrade", or "Extended Outage".
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_LANG
    Default language
    static final String
    ELM_LOCALNAME
    XML local name for EPPMaintenanceType.
    static final String
    ELM_NAME
    XML root tag for EPPMaintenance.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPMaintenanceType()
    Default constructor for EPPMaintenanceType.
    EPPMaintenanceType(String aType)
    Constructor for EPPMaintenanceType with the required attribute as a parameter.
    EPPMaintenanceType(String aType, String aLang)
    Constructor for EPPMaintenanceType with all of the attributes as parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPMaintenanceType.
    void
    decode(Element aElement)
    Decode the EPPMaintenanceType attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPMaintenanceType instance.
    boolean
    equals(Object aObject)
    implements a deep EPPMaintenanceType compare.
    String
    getLang()
    Gets the type language value.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getType()
    Gets the maintenance type
    boolean
    hasLang()
    Is the type language defined with a non-default value?
    void
    setLang(String aLang)
    Sets the type language value.
    void
    setType(String aType)
    Sets the maintenance type
    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

    • EPPMaintenanceType

      public EPPMaintenanceType()
      Default constructor for EPPMaintenanceType. The required attributes need to be set. The lang attribute defaults to DEFAULT_LANG.

    • EPPMaintenanceType

      public EPPMaintenanceType(String aType)
      Constructor for EPPMaintenanceType with the required attribute as a parameter.
      Parameters:
      aType - Type value

    • EPPMaintenanceType

      public EPPMaintenanceType(String aType, String aLang)
      Constructor for EPPMaintenanceType with all of the attributes as parameters.
      Parameters:
      aType - Type value
      aLang - Language of the type

  • Method Details

    • getType

      public String getType()
      Gets the maintenance type
      Returns:
      The type of the maintenance if defined; null otherwise.

    • setType

      public void setType(String aType)
      Sets the maintenance type
      Parameters:
      aType - Type of the maintenance

    • hasLang

      public boolean hasLang()
      Is the type language defined with a non-default value?
      Returns:
      true if the type language is defined; false otherwise.

    • getLang

      public String getLang()
      Gets the type language value.
      Returns:
      Type language if defined; DEFAULT_LANG otherwise.

    • setLang

      public void setLang(String aLang)
      Sets the type language value.
      Parameters:
      aLang - Type language for value.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPMaintenanceType instance.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPMaintenanceType instance.
      Throws:
      EPPEncodeException - Unable to encode EPPMaintenanceType instance.

    • decode

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

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPMaintenanceType compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPMaintenanceType instance to compare with
      Returns:
      true of aObject is equal to instance; false otherwise.

    • clone

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

    • getNamespace

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