|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.reseller.EPPResellerAddress
public class EPPResellerAddress
Represents a reseller address. Every reseller 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 reseller address is defined
as the following:
A <reseller:addr> element that contains address information associated
with the reseller. A <reseller:addr> element contains the following
child elements:
getStreets()
and
setStreets(List)
to get and set the elements.getCity()
and setCity(String)
to get and set the element.getStateProvince()
and
setStateProvince(String)
to get and set the element.getPostalCode()
and setPostalCode(String)
to get
and set the element.getCountry()
and
setCountry(String)
to get and set the element.
Field Summary | |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for EPPResellerDisclose . |
static java.lang.String |
ELM_NAME
XML root tag for EPPResellerPostalDefinition . |
Constructor Summary | |
---|---|
EPPResellerAddress()
Default constructor for EPPResellerAddress . |
|
EPPResellerAddress(java.util.List<java.lang.String> aStreets,
java.lang.String aCity,
java.lang.String aStateProvince,
java.lang.String aPostalCode,
java.lang.String aCountry)
Constructor for EPPResellerAddress all of the attributes as
parameters. |
|
EPPResellerAddress(java.lang.String aCity,
java.lang.String aCountry)
Constructor for EPPResellerAddress all of the required
attributes as parameters. |
Method Summary | |
---|---|
void |
addStreet(java.lang.String aStreetLine)
Add a street line to the street. |
java.lang.Object |
clone()
Clone EPPResellerAddress . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPResellerAddress attributes from the aElement
DOM Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the EPPResellerAddress instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPResellerAddress compare. |
java.lang.String |
getCity()
Gets the reseller city. |
java.lang.String |
getCountry()
Gets the reseller country. |
java.lang.String |
getPostalCode()
Gets the reseller postal code |
java.lang.String |
getStateProvince()
Gets the reseller state/province. |
java.util.List<java.lang.String> |
getStreets()
Gets the reseller street(s). |
boolean |
hasStreets()
Is there any street lines set? |
void |
setCity(java.lang.String aCity)
Sets the reseller city. |
void |
setCountry(java.lang.String aCountry)
Sets the reseller country. |
void |
setPostalCode(java.lang.String aPostalCode)
Sets the reseller postal code |
void |
setStateProvince(java.lang.String aStateProvince)
Sets the reseller state/province. |
void |
setStreet(java.lang.String aStreet)
Sets the reseller streets with only one line. |
void |
setStreets(java.util.List<java.lang.String> aStreets)
Sets the reseller streets attribute with a List>String> , where each element represents a line of
the street address. |
void |
setStreets(java.lang.String aStreet1,
java.lang.String aStreet2)
Sets the reseller street with two street lines. |
void |
setStreets(java.lang.String aStreet1,
java.lang.String aStreet2,
java.lang.String aStreet3)
Sets the reseller street with three street lines. |
java.lang.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 Detail |
---|
public static final java.lang.String ELM_LOCALNAME
EPPResellerDisclose
.
public static final java.lang.String ELM_NAME
EPPResellerPostalDefinition
.
Constructor Detail |
---|
public EPPResellerAddress()
EPPResellerAddress
. All the the
attributes default to null
. Must call required setter
methods before invoking encode(Document)
, which include:setCity(String)
setCountry(String)
public EPPResellerAddress(java.lang.String aCity, java.lang.String aCountry)
EPPResellerAddress
all of the required
attributes as parameters.
aCity
- Reseller streetaCountry
- Reseller countrypublic EPPResellerAddress(java.util.List<java.lang.String> aStreets, java.lang.String aCity, java.lang.String aStateProvince, java.lang.String aPostalCode, java.lang.String aCountry)
EPPResellerAddress
all of the attributes as
parameters.
aStreets
- List<String>
collection of streets (up to
maximum three)aCity
- Reseller streetaStateProvince
- Reseller state/provinceaPostalCode
- Reseller postal codeaCountry
- Reseller countryMethod Detail |
---|
public boolean hasStreets()
true
if there is at least one street line set.public void addStreet(java.lang.String aStreetLine)
aStreetLine
to the list of street lines.
aStreetLine
- Street line to add to the streetpublic java.util.List<java.lang.String> getStreets()
List<String>
of streets (up to
maximum three).public void setStreets(java.util.List<java.lang.String> aStreets)
List>String>
, where each element represents a line of
the street address.
aStreets
- Up to 3 street elementspublic void setStreet(java.lang.String aStreet)
List<String>
will be returned on a call to
getStreets()
after calling this method.
aStreet
- Reseller street.public void setStreets(java.lang.String aStreet1, java.lang.String aStreet2)
aStreet1
- First street lineaStreet2
- Second street linepublic void setStreets(java.lang.String aStreet1, java.lang.String aStreet2, java.lang.String aStreet3)
aStreet1
- First street lineaStreet2
- Second street lineaStreet3
- Third street linepublic java.lang.String getCity()
String
if defined; null
otherwise.public void setCity(java.lang.String aCity)
aCity
- reseller citypublic java.lang.String getStateProvince()
String
if defined; null
otherwise.public void setStateProvince(java.lang.String aStateProvince)
aStateProvince
- reseller state/provincepublic java.lang.String getPostalCode()
String
if defined; null
otherwise.public void setPostalCode(java.lang.String aPostalCode)
aPostalCode
- reseller postal codepublic java.lang.String getCountry()
String
if defined;
null
otherwise.public void setCountry(java.lang.String aCountry)
aCountry
- reseller countrypublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPResellerAddress
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.
EPPResellerAddress
instance.
EPPEncodeException
- Unable to encode EPPResellerAddress
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPResellerAddress
attributes from the aElement
DOM Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPResellerAddress
from.
EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPResellerAddress
compare.
equals
in class java.lang.Object
aObject
- EPPResellerAddress
instance to compare with
true
of aObject
is equal to instance;
false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPResellerAddress
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPResellerAddress
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |