Package com.authlete.common.dto
Class Address
- java.lang.Object
-
- com.authlete.common.dto.Address
-
- All Implemented Interfaces:
Serializable
public class Address extends Object implements Serializable
Address claim that represents a physical mailing address.- Since:
- 1.24
- Author:
- Takahiko Kawasaki
- See Also:
- OpenID Connect Core 1.0, 5.1.1. Address Claim, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Address()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCountry()
Get the country name component.String
getFormatted()
Get the full mailing address, formatted for display or use on a mailing label.String
getLocality()
Get the city or locality component.String
getPostalCode()
Get the zip code or postal code component.String
getRegion()
Get the state, province, prefecture, or region component.String
getStreetAddress()
Get the full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information.Address
setCountry(String country)
Set the country name component.Address
setFormatted(String formatted)
Set the full mailing address, formatted for display or use on a mailing label.Address
setLocality(String locality)
Set the city or locality component.Address
setPostaCode(String postalCode)
Set the zip code or postal code component.Address
setRegion(String region)
Set the state, province, prefecture, or region component.Address
setStreetAddress(String streetAddress)
Set the full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information.
-
-
-
Method Detail
-
getFormatted
public String getFormatted()
Get the full mailing address, formatted for display or use on a mailing label.- Returns:
- The full mailing address.
-
setFormatted
public Address setFormatted(String formatted)
Set the full mailing address, formatted for display or use on a mailing label.- Parameters:
formatted
- The full mailing address.- Returns:
this
object.
-
getStreetAddress
public String getStreetAddress()
Get the full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information.- Returns:
- The full street address.
-
setStreetAddress
public Address setStreetAddress(String streetAddress)
Set the full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information.- Parameters:
streetAddress
- The full street address.- Returns:
this
object.
-
getLocality
public String getLocality()
Get the city or locality component.- Returns:
- The city or locality.
-
setLocality
public Address setLocality(String locality)
Set the city or locality component.- Parameters:
locality
- The city or locality.- Returns:
this
object.
-
getRegion
public String getRegion()
Get the state, province, prefecture, or region component.- Returns:
- The state, province, prefecture, or region.
-
setRegion
public Address setRegion(String region)
Set the state, province, prefecture, or region component.- Parameters:
region
- The state, province, prefecture, or region.- Returns:
this
object.
-
getPostalCode
public String getPostalCode()
Get the zip code or postal code component.- Returns:
- The zip code or postal code.
-
setPostaCode
public Address setPostaCode(String postalCode)
Set the zip code or postal code component.- Parameters:
postalCode
- The zip code or postal code.- Returns:
this
object.
-
getCountry
public String getCountry()
Get the country name component.- Returns:
- The country name.
-
-