Provider (com.authlete:authlete-java-common 2.89 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<String,Object>
    - - com.authlete.common.assurance.Provider

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>
```
public class Provider
extends LinkedHashMap<String,Object>
```
The class that represents utility_bill/provider.

Since:

2.63

See Also:

OpenID Connect for Identity Assurance 1.0, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors
Constructor and Description

Provider()

Constructors
Constructor and Description
`Provider()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsCountry()` Check if this object contains `"country"`.
`boolean`	`containsFormatted()` Check if this object contains `"formatted"`.
`boolean`	`containsLocality()` Check if this object contains `"locality"`.
`boolean`	`containsName()` Check if this object contains `"name"`.
`boolean`	`containsPostalCode()` Check if this object contains `"postal_code"`.
`boolean`	`containsRegion()` Check if this object contains `"region"`.
`boolean`	`containsStreetAddress()` Check if this object contains `"street_address"`.
`static Provider`	`extract(Map<?,?> map, String key)` Create a `Provider` instance from an object in the given map.
`String`	`getCountry()` Get the country of the provider's address
`String`	`getFormatted()` Get the formatted address of the provider.
`String`	`getLocality()` Get the locality of the provider's address.
`String`	`getName()` Get the name of the provider.
`String`	`getPostalCode()` Get the postal code of the provider's address.
`String`	`getRegion()` Get the region of the provider's address.
`String`	`getStreetAddress()` Get the street address of the provider's address.
`String`	`removeCountry()` Remove `"country"` from this object.
`String`	`removeFormatted()` Remove `"formatted"` from this object.
`String`	`removeLocality()` Remove `"locality"` from this object.
`String`	`removeName()` Remove `"name"` from this object.
`String`	`removePostalCode()` Remove `"postal_code"` from this object.
`String`	`removeRegion()` Remove `"region"` from this object.
`String`	`removeStreetAddress()` Remove `"street_address"` from this object.
`Provider`	`setCountry(String country)` Set the country of the provider's address
`Provider`	`setFormatted(String formatted)` Set the formatted address of the provider.
`Provider`	`setLocality(String locality)` Set the locality of the provider's address.
`Provider`	`setName(String name)` Set the name of the provider.
`Provider`	`setPostalCode(String postalCode)` Set the postal code of the provider's address.
`Provider`	`setRegion(String region)` Set the region of the provider's address.
`Provider`	`setStreetAddress(String streetAddress)` Set the street address of the provider's address.

Methods inherited from class java.util.LinkedHashMap
clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap
clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

- Constructor Detail
  - Provider
```
public Provider()
```
- Method Detail
  - getName
```
public String getName()
```
    Get the name of the provider.
    
    Returns:
    
    The name of the provider.
  - setName
```
public Provider setName(String name)
```
    Set the name of the provider.
    
    Parameters:
    
    name - The name of the provider.
    
    Returns:
    
    this object.
  - containsName
```
public boolean containsName()
```
    Check if this object contains "name".
    
    Returns:
    
    true if this object contains "name".
  - removeName
```
public String removeName()
```
    Remove "name" from this object.
    
    Returns:
    
    The old value that may have existed before removal.
  - getFormatted
```
public String getFormatted()
```
    Get the formatted address of the provider.
    
    Returns:
    
    The formatted address of the provider.
    
    Since:
    
    2.67
  - setFormatted
```
public Provider setFormatted(String formatted)
```
    Set the formatted address of the provider.
    
    Parameters:
    
    formatted - The formatted address of the provider.
    
    Returns:
    
    this object.
    
    Since:
    
    2.67
  - containsFormatted
```
public boolean containsFormatted()
```
    Check if this object contains "formatted".
    
    Returns:
    
    true if this object contains "formatted".
    
    Since:
    
    2.67
  - removeFormatted
```
public String removeFormatted()
```
    Remove "formatted" from this object.
    
    Returns:
    
    The old value that may have existed before removal.
    
    Since:
    
    2.67
  - getStreetAddress
```
public String getStreetAddress()
```
    Get the street address of the provider's address.
    
    Returns:
    
    The street address of the provider's address.
  - setStreetAddress
```
public Provider setStreetAddress(String streetAddress)
```
    Set the street address of the provider's address.
    
    Parameters:
    
    streetAddress - The street address of the provider's address.
    
    Returns:
    
    this object.
  - containsStreetAddress
```
public boolean containsStreetAddress()
```
    Check if this object contains "street_address".
    
    Returns:
    
    true if this object contains "street_address".
  - removeStreetAddress
```
public String removeStreetAddress()
```
    Remove "street_address" from this object.
    
    Returns:
    
    The old value that may have existed before removal.
  - getLocality
```
public String getLocality()
```
    Get the locality of the provider's address.
    
    Returns:
    
    The locality of the provider's address.
    
    Since:
    
    2.67
  - setLocality
```
public Provider setLocality(String locality)
```
    Set the locality of the provider's address.
    
    Parameters:
    
    locality - The locality of the provider's address.
    
    Returns:
    
    this object.
    
    Since:
    
    2.67
  - containsLocality
```
public boolean containsLocality()
```
    Check if this object contains "locality".
    
    Returns:
    
    true if this object contains "locality".
    
    Since:
    
    2.67
  - removeLocality
```
public String removeLocality()
```
    Remove "locality" from this object.
    
    Returns:
    
    The old value that may have existed before removal.
    
    Since:
    
    2.67
  - getRegion
```
public String getRegion()
```
    Get the region of the provider's address.
    
    Returns:
    
    The region of the provider's address.
  - setRegion
```
public Provider setRegion(String region)
```
    Set the region of the provider's address.
    
    Parameters:
    
    region - The region of the provider's address.
    
    Returns:
    
    this object.
  - containsRegion
```
public boolean containsRegion()
```
    Check if this object contains "region".
    
    Returns:
    
    true if this object contains "region".
  - removeRegion
```
public String removeRegion()
```
    Remove "region" from this object.
    
    Returns:
    
    The old value that may have existed before removal.
  - getPostalCode
```
public String getPostalCode()
```
    Get the postal code of the provider's address.
    
    Returns:
    
    The postal code of the provider's address.
    
    Since:
    
    2.67
  - setPostalCode
```
public Provider setPostalCode(String postalCode)
```
    Set the postal code of the provider's address.
    
    Parameters:
    
    postalCode - The postal code of the provider's address.
    
    Returns:
    
    this object.
    
    Since:
    
    2.67
  - containsPostalCode
```
public boolean containsPostalCode()
```
    Check if this object contains "postal_code".
    
    Returns:
    
    true if this object contains "postal_code".
    
    Since:
    
    2.67
  - removePostalCode
```
public String removePostalCode()
```
    Remove "postal_code" from this object.
    
    Returns:
    
    The old value that may have existed before removal.
    
    Since:
    
    2.67
  - getCountry
```
public String getCountry()
```
    Get the country of the provider's address
    
    Returns:
    
    The country of the provider's address.
  - setCountry
```
public Provider setCountry(String country)
```
    Set the country of the provider's address
    
    Parameters:
    
    country - The country of the provider's address.
    
    Returns:
    
    this object.
  - containsCountry
```
public boolean containsCountry()
```
    Check if this object contains "country".
    
    Returns:
    
    true if this object contains "country".
  - removeCountry
```
public String removeCountry()
```
    Remove "country" from this object.
    
    Returns:
    
    The old value that may have existed before removal.
  - extract
```
public static Provider extract(Map<?,?> map,
                               String key)
                        throws IdentityAssuranceException
```
    Create a Provider instance from an object in the given map.
    
    Parameters:
    
    map - A map that may contain "provider".
    
    key - The key that identifies the object in the map. In normal cases, the key is "provider".
    
    Returns:
    
    A Provider instance that represents "provider". If the map does not contain the give key, null is returned.
    
    Throws:
    
    IdentityAssuranceException - The structure of the map does not conform to the specification (OpenID Connect for Identity Assurance 1.0).

Class Provider

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Provider

Method Detail

getName

setName

containsName

removeName

getFormatted

setFormatted

containsFormatted

removeFormatted

getStreetAddress

setStreetAddress

containsStreetAddress

removeStreetAddress

getLocality

setLocality

containsLocality

removeLocality

getRegion

setRegion

containsRegion

removeRegion

getPostalCode

setPostalCode

containsPostalCode

removePostalCode

getCountry

setCountry

containsCountry

removeCountry

extract