Class Birthplace

  • All Implemented Interfaces:
    net.minidev.json.JSONAware

    public final class Birthplace
    extends ClaimsSet
    Birthplace claims set, serialisable to a JSON object.

    Related specifications:

    • OpenID Connect for Identity Assurance 1.0, section 4.1.
    • Constructor Detail

      • Birthplace

        public Birthplace​(CountryCode countryCode,
                          String region,
                          String locality)
        Creates a new birthplace claims set.
        Parameters:
        countryCode - The country code, as ISO3166-1 or ISO3166-3 code, null if not specified.
        region - State, province, prefecture, or region component, null if not specified.
        locality - City or other locality, null if not specified.
      • Birthplace

        public Birthplace​(net.minidev.json.JSONObject jsonObject)
        Creates a new birthplace claims set from the specified JSON object.
        Parameters:
        jsonObject - The JSON object. Must not be null.
    • Method Detail

      • getStandardClaimNames

        public static Set<StringgetStandardClaimNames()
        Gets the names of the standard birthplace claims.
        Returns:
        The names of the standard birthplace claims (read-only set).
      • getCountry

        public CountryCode getCountry()
        Gets the country code.
        Returns:
        The country code, null if not specified or illegal ISO3166-1 or ISO3166-3 country code.
      • setCountry

        public void setCountry​(CountryCode country)
        Sets the country.
        Parameters:
        country - The country, null if not specified.
      • getRegion

        public String getRegion()
        Gets the tate, province, prefecture, or region component.
        Returns:
        The state, province, prefecture, or region component, null if not specified.
      • setRegion

        public void setRegion​(String region)
        Sets the tate, province, prefecture, or region component.
        Parameters:
        region - The state, province, prefecture, or region component, null if not specified.
      • getLocality

        public String getLocality()
        Gets the city or other locality.
        Returns:
        The city or other locality, null if not specified.
      • setLocality

        public void setLocality​(String locality)
        Sets the city or other locality.
        Parameters:
        locality - The city or other locality, null if not specified.