|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.model.Element
com.google.gdata.model.gd.StructuredPostalAddress
public class StructuredPostalAddress
Describes a structured postal address.
Nested Class Summary | |
---|---|
static class |
StructuredPostalAddress.MailClass
The mail class. |
static class |
StructuredPostalAddress.Rel
The postal address type. |
static class |
StructuredPostalAddress.Usage
The context for the address use. |
Field Summary | |
---|---|
static ElementKey<java.lang.Void,StructuredPostalAddress> |
KEY
The key for this element. |
static AttributeKey<java.lang.String> |
LABEL
Simple string value used to name this address. |
static AttributeKey<java.lang.String> |
MAIL_CLASS
The mail class. |
static AttributeKey<java.lang.Boolean> |
PRIMARY
Whether this is the primary postal address. |
static AttributeKey<java.lang.String> |
REL
The postal address type. |
static AttributeKey<java.lang.String> |
USAGE
The context for the address use. |
Constructor Summary | |
---|---|
|
StructuredPostalAddress()
Constructs an instance using the default key. |
protected |
StructuredPostalAddress(ElementKey<?,? extends StructuredPostalAddress> key)
Subclass constructor, allows subclasses to supply their own element key. |
protected |
StructuredPostalAddress(ElementKey<?,? extends StructuredPostalAddress> key,
Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance. |
Method Summary | |
---|---|
Agent |
getAgent()
Returns the Used in work addresses. |
City |
getCity()
Returns the Can be city, village, town, borough, etc. |
Country |
getCountry()
Returns the The country name. |
FormattedAddress |
getFormattedAddress()
Returns the The full, unstructured address. |
HouseName |
getHousename()
Returns the Used in places where houses or buildings have names. |
java.lang.String |
getLabel()
Returns the Simple string value used to name this address. |
java.lang.String |
getMailClass()
Returns the The mail class. |
Neighborhood |
getNeighborhood()
Returns the Neighborhood. |
PoBox |
getPobox()
Returns the P.O. |
PostCode |
getPostcode()
Returns the Postal code. |
java.lang.Boolean |
getPrimary()
Returns the whether this is the primary postal address. |
Region |
getRegion()
Returns the Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc. |
java.lang.String |
getRel()
Returns the the postal address type. |
Street |
getStreet()
Returns the Can be street, avenue, road, etc. |
Subregion |
getSubregion()
Returns the Subregion is county (US), province (in Italy), etc. |
java.lang.String |
getUsage()
Returns the The context for the address use. |
boolean |
hasAgent()
Returns whether it has the Used in work addresses. |
boolean |
hasCity()
Returns whether it has the Can be city, village, town, borough, etc. |
boolean |
hasCountry()
Returns whether it has the The country name. |
boolean |
hasFormattedAddress()
Returns whether it has the The full, unstructured address. |
boolean |
hasHousename()
Returns whether it has the Used in places where houses or buildings have names. |
boolean |
hasLabel()
Returns whether it has the Simple string value used to name this address. |
boolean |
hasMailClass()
Returns whether it has the The mail class. |
boolean |
hasNeighborhood()
Returns whether it has the Neighborhood. |
boolean |
hasPobox()
Returns whether it has the P.O. |
boolean |
hasPostcode()
Returns whether it has the Postal code. |
boolean |
hasPrimary()
Returns whether it has the whether this is the primary postal address. |
boolean |
hasRegion()
Returns whether it has the Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc. |
boolean |
hasRel()
Returns whether it has the the postal address type. |
boolean |
hasStreet()
Returns whether it has the Can be street, avenue, road, etc. |
boolean |
hasSubregion()
Returns whether it has the Subregion is county (US), province (in Italy), etc. |
boolean |
hasUsage()
Returns whether it has the The context for the address use. |
StructuredPostalAddress |
lock()
Locks this element. |
static void |
registerMetadata(MetadataRegistry registry)
Registers the metadata for this element. |
StructuredPostalAddress |
setAgent(Agent agent)
Sets the Used in work addresses. |
StructuredPostalAddress |
setCity(City city)
Sets the Can be city, village, town, borough, etc. |
StructuredPostalAddress |
setCountry(Country country)
Sets the The country name. |
StructuredPostalAddress |
setFormattedAddress(FormattedAddress formattedAddress)
Sets the The full, unstructured address. |
StructuredPostalAddress |
setHousename(HouseName housename)
Sets the Used in places where houses or buildings have names. |
StructuredPostalAddress |
setLabel(java.lang.String label)
Sets the Simple string value used to name this address. |
StructuredPostalAddress |
setMailClass(java.lang.String mailClass)
Sets the The mail class. |
StructuredPostalAddress |
setNeighborhood(Neighborhood neighborhood)
Sets the Neighborhood. |
StructuredPostalAddress |
setPobox(PoBox pobox)
Sets the P.O. |
StructuredPostalAddress |
setPostcode(PostCode postcode)
Sets the Postal code. |
StructuredPostalAddress |
setPrimary(java.lang.Boolean primary)
Sets the whether this is the primary postal address. |
StructuredPostalAddress |
setRegion(Region region)
Sets the Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc. |
StructuredPostalAddress |
setRel(java.lang.String rel)
Sets the the postal address type. |
StructuredPostalAddress |
setStreet(Street street)
Sets the Can be street, avenue, road, etc. |
StructuredPostalAddress |
setSubregion(Subregion subregion)
Sets the Subregion is county (US), province (in Italy), etc. |
StructuredPostalAddress |
setUsage(java.lang.String usage)
Sets the The context for the address use. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ElementKey<java.lang.Void,StructuredPostalAddress> KEY
public static final AttributeKey<java.lang.String> LABEL
public static final AttributeKey<java.lang.String> MAIL_CLASS
public static final AttributeKey<java.lang.Boolean> PRIMARY
public static final AttributeKey<java.lang.String> REL
public static final AttributeKey<java.lang.String> USAGE
Constructor Detail |
---|
public StructuredPostalAddress()
protected StructuredPostalAddress(ElementKey<?,? extends StructuredPostalAddress> key)
protected StructuredPostalAddress(ElementKey<?,? extends StructuredPostalAddress> key, Element source)
Element
instance. Will use the given ElementKey
as the key
for the element. This constructor is used when adapting from one element
key to another. You cannot call this constructor directly, instead use
Element.createElement(ElementKey, Element)
.
key
- The key to use for this element.source
- source elementMethod Detail |
---|
public static void registerMetadata(MetadataRegistry registry)
public StructuredPostalAddress lock()
Element
lock
in class Element
public Agent getAgent()
public StructuredPostalAddress setAgent(Agent agent)
agent
- Used in work addresses. Also for 'in care of' or 'c/o' or
null
to reset
public boolean hasAgent()
public City getCity()
public StructuredPostalAddress setCity(City city)
city
- Can be city, village, town, borough, etc or null
to
reset
public boolean hasCity()
public Country getCountry()
public StructuredPostalAddress setCountry(Country country)
country
- The country name or null
to reset
public boolean hasCountry()
public FormattedAddress getFormattedAddress()
public StructuredPostalAddress setFormattedAddress(FormattedAddress formattedAddress)
formattedAddress
- The full, unstructured address or null
to
reset
public boolean hasFormattedAddress()
public HouseName getHousename()
public StructuredPostalAddress setHousename(HouseName housename)
housename
- Used in places where houses or buildings have names or
null
to reset
public boolean hasHousename()
public java.lang.String getLabel()
public StructuredPostalAddress setLabel(java.lang.String label)
label
- Simple string value used to name this address or null
to reset
public boolean hasLabel()
public java.lang.String getMailClass()
public StructuredPostalAddress setMailClass(java.lang.String mailClass)
mailClass
- The mail class or null
to reset
public boolean hasMailClass()
public Neighborhood getNeighborhood()
public StructuredPostalAddress setNeighborhood(Neighborhood neighborhood)
neighborhood
- Neighborhood. Used to disambiguate a street or null
to reset
public boolean hasNeighborhood()
public PoBox getPobox()
public StructuredPostalAddress setPobox(PoBox pobox)
pobox
- P.O. box or null
to reset
public boolean hasPobox()
public PostCode getPostcode()
public StructuredPostalAddress setPostcode(PostCode postcode)
postcode
- Postal code or null
to reset
public boolean hasPostcode()
public java.lang.Boolean getPrimary()
public StructuredPostalAddress setPrimary(java.lang.Boolean primary)
primary
- whether this is the primary postal address or null
to reset
public boolean hasPrimary()
public Region getRegion()
public StructuredPostalAddress setRegion(Region region)
region
- Region is state, province, county (in Ireland), Land (in
Germany), departement (in France), etc or null
to reset
public boolean hasRegion()
public java.lang.String getRel()
public StructuredPostalAddress setRel(java.lang.String rel)
rel
- the postal address type or null
to reset
public boolean hasRel()
public Street getStreet()
public StructuredPostalAddress setStreet(Street street)
street
- Can be street, avenue, road, etc. This element also includes
the house number and room/apartment/flat/floor number or null
to reset
public boolean hasStreet()
public Subregion getSubregion()
public StructuredPostalAddress setSubregion(Subregion subregion)
subregion
- Subregion is county (US), province (in Italy), etc or
null
to reset
public boolean hasSubregion()
public java.lang.String getUsage()
public StructuredPostalAddress setUsage(java.lang.String usage)
usage
- The context for the address use or null
to reset
public boolean hasUsage()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |