Class DefaultAddressStandardClaim

java.lang.Object

org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

All Implemented Interfaces:

AddressStandardClaim

public final class DefaultAddressStandardClaim
extends Object
implements AddressStandardClaim

The default implementation of an Address Claim.

Since:

5.0

See Also:

• AddressStandardClaim

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultAddressStandardClaim.Builder	A builder for DefaultAddressStandardClaim.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
@Nullable String	getCountry()	Returns the country, or null if it does not exist.
@Nullable String	getFormatted()	Returns the full mailing address, formatted for display, or null if it does not exist.
@Nullable String	getLocality()	Returns the city or locality, or null if it does not exist.
@Nullable String	getPostalCode()	Returns the zip code or postal code, or null if it does not exist.
@Nullable String	getRegion()	Returns the state, province, prefecture, or region, or null if it does not exist.
@Nullable String	getStreetAddress()	Returns the full street address, which may include house number, street name, P.O.
int	hashCode()

Methods inherited from class Object

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

Method Details

getFormatted

public @Nullable String getFormatted()

Description copied from interface: AddressStandardClaim

Returns the full mailing address, formatted for display, or null if it does not exist.

Specified by:

getFormatted in interface AddressStandardClaim

Returns:

the full mailing address, or null if it does not exist

getStreetAddress

public @Nullable String getStreetAddress()

Description copied from interface: AddressStandardClaim

Returns the full street address, which may include house number, street name, P.O. Box, etc., or null if it does not exist.

Specified by:

getStreetAddress in interface AddressStandardClaim

Returns:

the full street address, or null if it does not exist

getLocality

public @Nullable String getLocality()

Description copied from interface: AddressStandardClaim

Returns the city or locality, or null if it does not exist.

Specified by:

getLocality in interface AddressStandardClaim

Returns:

the city or locality, or null if it does not exist

getRegion

public @Nullable String getRegion()

Description copied from interface: AddressStandardClaim

Returns the state, province, prefecture, or region, or null if it does not exist.

Specified by:

getRegion in interface AddressStandardClaim

Returns:

the state, province, prefecture, or region, or null if it does not exist

getPostalCode

public @Nullable String getPostalCode()

Description copied from interface: AddressStandardClaim

Returns the zip code or postal code, or null if it does not exist.

Specified by:

getPostalCode in interface AddressStandardClaim

Returns:

the zip code or postal code, or null if it does not exist

getCountry

public @Nullable String getCountry()

Description copied from interface: AddressStandardClaim

Returns the country, or null if it does not exist.

Specified by:

getCountry in interface AddressStandardClaim

Returns:

the country, or null if it does not exist

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object