Class GeoLocationDetails

    • Constructor Detail

      • GeoLocationDetails

        public GeoLocationDetails()
    • Method Detail

      • setContinentCode

        public void setContinentCode​(String continentCode)

        The code for a continent geo location. Note: only continent locations have a continent code.

        Parameters:
        continentCode - The code for a continent geo location. Note: only continent locations have a continent code.
      • getContinentCode

        public String getContinentCode()

        The code for a continent geo location. Note: only continent locations have a continent code.

        Returns:
        The code for a continent geo location. Note: only continent locations have a continent code.
      • withContinentCode

        public GeoLocationDetails withContinentCode​(String continentCode)

        The code for a continent geo location. Note: only continent locations have a continent code.

        Parameters:
        continentCode - The code for a continent geo location. Note: only continent locations have a continent code.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setContinentName

        public void setContinentName​(String continentName)

        The name of the continent. This element is only present if ContinentCode is also present.

        Parameters:
        continentName - The name of the continent. This element is only present if ContinentCode is also present.
      • getContinentName

        public String getContinentName()

        The name of the continent. This element is only present if ContinentCode is also present.

        Returns:
        The name of the continent. This element is only present if ContinentCode is also present.
      • withContinentName

        public GeoLocationDetails withContinentName​(String continentName)

        The name of the continent. This element is only present if ContinentCode is also present.

        Parameters:
        continentName - The name of the continent. This element is only present if ContinentCode is also present.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCountryCode

        public void setCountryCode​(String countryCode)

        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Parameters:
        countryCode - The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

      • getCountryCode

        public String getCountryCode()

        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Returns:
        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

      • withCountryCode

        public GeoLocationDetails withCountryCode​(String countryCode)

        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Parameters:
        countryCode - The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCountryName

        public void setCountryName​(String countryName)

        The name of the country. This element is only present if CountryCode is also present.

        Parameters:
        countryName - The name of the country. This element is only present if CountryCode is also present.
      • getCountryName

        public String getCountryName()

        The name of the country. This element is only present if CountryCode is also present.

        Returns:
        The name of the country. This element is only present if CountryCode is also present.
      • withCountryName

        public GeoLocationDetails withCountryName​(String countryName)

        The name of the country. This element is only present if CountryCode is also present.

        Parameters:
        countryName - The name of the country. This element is only present if CountryCode is also present.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSubdivisionCode

        public void setSubdivisionCode​(String subdivisionCode)

        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Parameters:
        subdivisionCode - The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
      • getSubdivisionCode

        public String getSubdivisionCode()

        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Returns:
        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
      • withSubdivisionCode

        public GeoLocationDetails withSubdivisionCode​(String subdivisionCode)

        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Parameters:
        subdivisionCode - The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSubdivisionName

        public void setSubdivisionName​(String subdivisionName)

        The name of the subdivision. This element is only present if SubdivisionCode is also present.

        Parameters:
        subdivisionName - The name of the subdivision. This element is only present if SubdivisionCode is also present.
      • getSubdivisionName

        public String getSubdivisionName()

        The name of the subdivision. This element is only present if SubdivisionCode is also present.

        Returns:
        The name of the subdivision. This element is only present if SubdivisionCode is also present.
      • withSubdivisionName

        public GeoLocationDetails withSubdivisionName​(String subdivisionName)

        The name of the subdivision. This element is only present if SubdivisionCode is also present.

        Parameters:
        subdivisionName - The name of the subdivision. This element is only present if SubdivisionCode is also present.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object