com.unboundid.scim.data

Class Address

java.lang.Object

com.unboundid.scim.data.Address

public class Address
extends Object

This class represents the address complex attribute in user resources.

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeValueResolver<Address>	ADDRESS_RESOLVER The AttributeValueResolver that resolves SCIM attribute values to/from Address instances.

Constructor Summary

Constructors

Constructor and Description
Address(String formatted, String streetAddress, String locality, String region, String postalCode, String country, String type, boolean primary) Create an instance of the SCIM addresses attribute.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCountry() Retrieves the country name component.
String	getFormatted() Retrieves the full mailing address, formatted for display or use with a mailing label.
String	getLocality() Retrieves the city or locality component.
String	getPostalCode() Retrieves the zip code or postal code component.
String	getRegion() Retrieves the state or region component.
String	getStreetAddress() Retrieves the full street address component, which may include house number, street name, PO BOX, and multi-line.
String	getType() Retrieves the type of address, "work", "home" or "other".
int	hashCode()
boolean	isPrimary() Whether this value is the primary value.
void	setCountry(String country) Sets the country name component.
void	setFormatted(String formatted) Sets the full mailing address, formatted for display or use with a mailing label.
void	setLocality(String locality) Sets the city or locality component.
void	setPostalCode(String postalCode) Sets the zip code or postal code component.
void	setPrimary(boolean primary) Specifies whether this value is the primary value.
void	setRegion(String region) Sets the state or region component.
void	setStreetAddress(String streetAddress) Sets The full street address component, which may include house number, street name, PO BOX, and multi-line.
void	setType(String type) Sets the type of address, "work", "home" or "other".
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADDRESS_RESOLVER

public static final AttributeValueResolver<Address> ADDRESS_RESOLVER

The AttributeValueResolver that resolves SCIM attribute values to/from Address instances.

Constructor Detail

Address

public Address(String formatted,
       String streetAddress,
       String locality,
       String region,
       String postalCode,
       String country,
       String type,
       boolean primary)

Create an instance of the SCIM addresses attribute.

Parameters:

primary - Specifies whether this value is the primary value.

streetAddress - The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.

locality - The city or locality component.

region - The state or region component.

postalCode - The zip code or postal code component.

country - The country name component.

formatted - The full mailing address, formatted for display or use with a mailing label.

type - The type of address, "work", "home" or "other".

Method Detail

getCountry

public String getCountry()

Retrieves the country name component.

Returns:

The country name component.

setCountry

public void setCountry(String country)

Sets the country name component.

Parameters:

country - The country name component.

getFormatted

public String getFormatted()

Retrieves the full mailing address, formatted for display or use with a mailing label.

Returns:

The full mailing address

setFormatted

public void setFormatted(String formatted)

Sets the full mailing address, formatted for display or use with a mailing label.

Parameters:

formatted - The full mailing address.

getLocality

public String getLocality()

Retrieves the city or locality component.

Returns:

The city or locality component.

setLocality

public void setLocality(String locality)

Sets the city or locality component.

Parameters:

locality - The city or locality component.

getPostalCode

public String getPostalCode()

Retrieves the zip code or postal code component.

Returns:

The zip code or postal code component.

setPostalCode

public void setPostalCode(String postalCode)

Sets the zip code or postal code component.

Parameters:

postalCode - The zip code or postal code component.

isPrimary

public boolean isPrimary()

Whether this value is the primary value.

Returns:

true if this value is the primary value or false otherwise.

setPrimary

public void setPrimary(boolean primary)

Specifies whether this value is the primary value.

Parameters:

primary - Whether this value is the primary value.

getRegion

public String getRegion()

Retrieves the state or region component.

Returns:

The state or region component.

setRegion

public void setRegion(String region)

Sets the state or region component.

Parameters:

region - The state or region component.

getStreetAddress

public String getStreetAddress()

Retrieves the full street address component, which may include house number, street name, PO BOX, and multi-line.

Returns:

The full street address component.

setStreetAddress

public void setStreetAddress(String streetAddress)

Sets The full street address component, which may include house number, street name, PO BOX, and multi-line.

Parameters:

streetAddress - The full street address component.

getType

public String getType()

Retrieves the type of address, "work", "home" or "other".

Returns:

The type of address.

setType

public void setType(String type)

Sets the type of address, "work", "home" or "other".

Parameters:

type - he type of address.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object