java.lang.Object
- com.nimbusds.openid.connect.sdk.claims.ClaimsSet
- - com.nimbusds.openid.connect.sdk.claims.Address

All Implemented Interfaces:

net.minidev.json.JSONAware
```
public class Address
extends ClaimsSet
```
UserInfo address claims set, serialisable to a JSON object.
Related specifications:
- OpenID Connect Core 1.0, section 5.1.1.
- OpenID Connect for Identity Assurance 1.0, section 4.3.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`COUNTRY_CLAIM_NAME`	The country claim name.
`static String`	`COUNTRY_CODE_CLAIM_NAME`	The country code claim name.
`static String`	`FORMATTED_CLAIM_NAME`	The formatted claim name.
`static String`	`LOCALITY_CLAIM_NAME`	The locality claim name.
`static String`	`POSTAL_CODE_CLAIM_NAME`	The postal code claim name.
`static String`	`REGION_CLAIM_NAME`	The region claim name.
`static String`	`STREET_ADDRESS_CLAIM_NAME`	The street address claim name.

Fields inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet
AUD_CLAIM_NAME, claims, ISS_CLAIM_NAME

Constructor Summary

Constructors
Constructor	Description
`Address()`	Creates a new minimal (empty) UserInfo address claims set.
`Address(net.minidev.json.JSONObject jsonObject)`	Creates a new UserInfo address claims set from the specified JSON object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCountry()`	Gets the country name component.
`CountryCode`	`getCountryCode()`	Gets the country code component.
`String`	`getFormatted()`	Gets the full mailing address, formatted for display or use with a mailing label.
`String`	`getLocality()`	Gets the city or locality component.
`String`	`getPostalCode()`	Gets the zip code or postal code component.
`String`	`getRegion()`	Gets the state, province, prefecture or region component.
`static Set<String>`	`getStandardClaimNames()`	Gets the names of the standard UserInfo address claims.
`String`	`getStreetAddress()`	Gets the full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.
`static Address`	`parse(String json)`	Parses an address claims set from the specified JSON object string.
`void`	`setCountry(String country)`	Sets the country name component.
`void`	`setCountryCode(CountryCode countryCode)`	Sets the country code 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`	`setRegion(String region)`	Sets the state, province, prefecture 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 extended street address information.

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet
equals, getAudience, getBooleanClaim, getClaim, getClaim, getDateClaim, getIssuer, getJSONObjectClaim, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getStringListClaim, getURIClaim, getURLClaim, hashCode, putAll, putAll, setAudience, setAudience, setClaim, setClaim, setDateClaim, setIssuer, setURIClaim, setURLClaim, toJSONObject, toJSONString, toJWTClaimsSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FORMATTED_CLAIM_NAME
```
public static final String FORMATTED_CLAIM_NAME
```
    The formatted claim name.
    
    See Also:
    
    Constant Field Values
  - STREET_ADDRESS_CLAIM_NAME
```
public static final String STREET_ADDRESS_CLAIM_NAME
```
    The street address claim name.
    
    See Also:
    
    Constant Field Values
  - LOCALITY_CLAIM_NAME
```
public static final String LOCALITY_CLAIM_NAME
```
    The locality claim name.
    
    See Also:
    
    Constant Field Values
  - REGION_CLAIM_NAME
```
public static final String REGION_CLAIM_NAME
```
    The region claim name.
    
    See Also:
    
    Constant Field Values
  - POSTAL_CODE_CLAIM_NAME
```
public static final String POSTAL_CODE_CLAIM_NAME
```
    The postal code claim name.
    
    See Also:
    
    Constant Field Values
  - COUNTRY_CLAIM_NAME
```
public static final String COUNTRY_CLAIM_NAME
```
    The country claim name.
    
    See Also:
    
    Constant Field Values
  - COUNTRY_CODE_CLAIM_NAME
```
public static final String COUNTRY_CODE_CLAIM_NAME
```
    The country code claim name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Address
```
public Address()
```
    Creates a new minimal (empty) UserInfo address claims set.
  - Address
```
public Address(net.minidev.json.JSONObject jsonObject)
```
    Creates a new UserInfo address claims set from the specified JSON object.
    
    Parameters:
    
    jsonObject - The JSON object. Must not be null.
- Method Detail
  - getStandardClaimNames
```
public static Set<String> getStandardClaimNames()
```
    Gets the names of the standard UserInfo address claims.
    
    Returns:
    
    The names of the standard UserInfo address claims (read-only set).
  - setFormatted
```
public void setFormatted(String formatted)
```
    Sets the full mailing address, formatted for display or use with a mailing label. May contain newlines. Corresponds to the formatted claim.
    
    Parameters:
    
    formatted - The full mailing address. null if not specified.
  - getFormatted
```
public String getFormatted()
```
    Gets the full mailing address, formatted for display or use with a mailing label. May contain newlines. Corresponds to the formatted claim.
    
    Returns:
    
    The full mailing address, null if not specified.
  - setStreetAddress
```
public void setStreetAddress(String streetAddress)
```
    Sets the full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. May contain newlines. Corresponds to the street_address claim.
    
    Parameters:
    
    streetAddress - The full street address component. If null the claim will be removed.
  - getStreetAddress
```
public String getStreetAddress()
```
    Gets the full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. May contain newlines. Corresponds to the street_address claim.
    
    Returns:
    
    The full street address component, null if not specified.
  - setLocality
```
public void setLocality(String locality)
```
    Sets the city or locality component. Corresponds to the locality claim.
    
    Parameters:
    
    locality - The city or locality component. If null the claim will be removed.
  - getLocality
```
public String getLocality()
```
    Gets the city or locality component. Corresponds to the locality claim, with no language tag.
    
    Returns:
    
    The city or locality component, null if not specified.
  - setRegion
```
public void setRegion(String region)
```
    Sets the state, province, prefecture or region component. Corresponds to the region claim.
    
    Parameters:
    
    region - The state, province, prefecture or region component. If null the claim will be removed.
  - getRegion
```
public String getRegion()
```
    Gets the state, province, prefecture or region component. Corresponds to the region claim.
    
    Returns:
    
    The state, province, prefecture or region component, null if not specified.
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Sets the zip code or postal code component. Corresponds to the postal_code claim.
    
    Parameters:
    
    postalCode - The zip code or postal code component. If null the claim will be removed.
  - getPostalCode
```
public String getPostalCode()
```
    Gets the zip code or postal code component. Corresponds to the postal_code claim.
    
    Returns:
    
    The zip code or postal code component, null if not specified.
  - setCountry
```
public void setCountry(String country)
```
    Sets the country name component. Corresponds to the country claim.
    
    Parameters:
    
    country - The country name component. If null the claim will be removed.
  - getCountry
```
public String getCountry()
```
    Gets the country name component. Corresponds to the country claim.
    
    Returns:
    
    The country name component, null if not specified.
  - setCountryCode
```
public void setCountryCode(CountryCode countryCode)
```
    Sets the country code component. Corresponds to the country_code claim.
    
    Parameters:
    
    countryCode - The country code component. If null the claim will be removed.
  - getCountryCode
```
public CountryCode getCountryCode()
```
    Gets the country code component. Corresponds to the country_code claim.
    
    Returns:
    
    The country code component, null if not specified.
  - parse
```
public static Address parse(String json)
                     throws ParseException
```
    Parses an address claims set from the specified JSON object string.
    
    Parameters:
    
    json - The JSON object string to parse. Must not be null.
    
    Returns:
    
    The address claims set.
    
    Throws:
    
    ParseException - If parsing failed.

Class Address

Field Summary

Fields inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet

Constructor Summary

Method Summary

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet

Methods inherited from class java.lang.Object

Field Detail

FORMATTED_CLAIM_NAME

STREET_ADDRESS_CLAIM_NAME

LOCALITY_CLAIM_NAME

REGION_CLAIM_NAME

POSTAL_CODE_CLAIM_NAME

COUNTRY_CLAIM_NAME

COUNTRY_CODE_CLAIM_NAME

Constructor Detail

Address

Address

Method Detail

getStandardClaimNames

setFormatted

getFormatted

setStreetAddress

getStreetAddress

setLocality

getLocality

setRegion

getRegion

setPostalCode

getPostalCode

setCountry

getCountry

setCountryCode

getCountryCode

parse