Package com.verisign.epp.codec.validate.v02

Class EPPValidateAddress

java.lang.Object
com.verisign.epp.codec.validate.v02.EPPValidateAddress
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPValidateAddress extends Object implements EPPCodecComponent
Represents a contact address. Every contact has associated postal address information. A postal address contains OPTIONAL street information, city information, OPTIONAL state/province information, an OPTIONAL postal code, and a country identifier as described in [ISO11180]. Address information MAY be provided in both a subset of UTF-8 [RFC2279] that can be represented in 7-bit ASCII [US-ASCII] and unrestricted UTF-8. A contact address is defined as the following:

A <validate:addr> element that contains address information associated with the contact. A <validate:addr> element contains the following child elements:

  • OPTIONAL <validate:street> elements (up to a maximum of three) that contain the contact's street address. Use getStreets() and setStreets(List) to get and set the elements.
  • A <validate:city> element that contains the contact's city. Use getCity() and setCity(String) to get and set the element.
  • A <validate:sp> element that contains the contact's state or province. This element is OPTIONAL for addressing schemes that do not require a state or province name. Use getStateProvince() and setStateProvince(String) to get and set the element.
  • An OPTIONAL <validate:pc> element that contains the contact's postal code. Use getPostalCode() and setPostalCode(String) to get and set the element.
  • A <validate:cc> element that contains the two-character identifier representing with the contact's country. Use getCountry() and setCountry(String) to get and set the element.
See Also:

  • Field Details

  • Constructor Details

    • EPPValidateAddress

      public EPPValidateAddress()
      Default constructor for EPPValidateAddress. All the the attributes default to null. Must call required setter methods before invoking encode(Document), which include:

    • EPPValidateAddress

      public EPPValidateAddress(String aCity, String aCountry)
      Constructor for EPPValidateAddress all of the required attributes as parameters.
      Parameters:
      aCity - Contact street
      aCountry - Contact country

    • EPPValidateAddress

      public EPPValidateAddress(List<String> aStreets, String aCity, String aStateProvince, String aPostalCode, String aCountry)
      Constructor for EPPValidateAddress all of the attributes as parameters.
      Parameters:
      aStreets - List&lt;String&gt; collection of streets (up to maximum three)
      aCity - Contact street
      aStateProvince - Contact state/province
      aPostalCode - Contact postal code
      aCountry - Contact country

  • Method Details

    • hasStreets

      public boolean hasStreets()
      Is there any street lines set?
      Returns:
      true if there is at least one street line set.

    • addStreet

      public void addStreet(String aStreetLine)
      Add a street line to the street. This will add aStreetLine to the list of street lines.
      Parameters:
      aStreetLine - Street line to add to the street

    • getStreets

      public List<String> getStreets()
      Gets the contact street(s).
      Returns:
      street(s) as a List&lt;String&gt; of streets (up to maximum three).

    • setStreets

      public void setStreets(List<String> aStreets)
      Sets the contact streets attribute with a List&gt;String&gt;, where each element represents a line of the street address.
      Parameters:
      aStreets - Up to 3 street elements

    • setStreet

      public void setStreet(String aStreet)
      Sets the contact streets with only one line. Only a one element List&lt;String&gt; will be returned on a call to getStreets() after calling this method.
      Parameters:
      aStreet - Contact street.

    • setStreets

      public void setStreets(String aStreet1, String aStreet2)
      Sets the contact street with two street lines.
      Parameters:
      aStreet1 - First street line
      aStreet2 - Second street line

    • setStreets

      public void setStreets(String aStreet1, String aStreet2, String aStreet3)
      Sets the contact street with three street lines.
      Parameters:
      aStreet1 - First street line
      aStreet2 - Second street line
      aStreet3 - Third street line

    • getCity

      public String getCity()
      Gets the contact city.
      Returns:
      city. String if defined; null otherwise.

    • setCity

      public void setCity(String aCity)
      Sets the contact city.
      Parameters:
      aCity - contact city

    • getStateProvince

      public String getStateProvince()
      Gets the contact state/province.
      Returns:
      state/province. String if defined; null otherwise.

    • setStateProvince

      public void setStateProvince(String aStateProvince)
      Sets the contact state/province.
      Parameters:
      aStateProvince - contact state/province

    • getPostalCode

      public String getPostalCode()
      Gets the contact postal code
      Returns:
      postal code String if defined; null otherwise.

    • setPostalCode

      public void setPostalCode(String aPostalCode)
      Sets the contact postal code
      Parameters:
      aPostalCode - contact postal code

    • getCountry

      public String getCountry()
      Gets the contact country.
      Returns:
      contact country String if defined; null otherwise.

    • setCountry

      public void setCountry(String aCountry)
      Sets the contact country.
      Parameters:
      aCountry - contact country

    • encode

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

    • decode

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

    • equals

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

    • clone

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