Class AddressComponentMatchScores

    • Method Detail

      • country

        public final Double country()

        The alpha-2 or alpha-3 character code for the country that the results will be present in.

        Returns:
        The alpha-2 or alpha-3 character code for the country that the results will be present in.
      • region

        public final Double region()

        The region or state results should be to be present in.

        Example: North Rhine-Westphalia.

        Returns:
        The region or state results should be to be present in.

        Example: North Rhine-Westphalia.

      • subRegion

        public final Double subRegion()

        The sub-region or county for which results should be present in.

        Returns:
        The sub-region or county for which results should be present in.
      • locality

        public final Double locality()

        The city or locality results should be present in.

        Example: Vancouver.

        Returns:
        The city or locality results should be present in.

        Example: Vancouver.

      • district

        public final Double district()

        The district or division of a city the results should be present in.

        Returns:
        The district or division of a city the results should be present in.
      • subDistrict

        public final Double subDistrict()

        A subdivision of a district.

        Example: Minden-Lübbecke

        Returns:
        A subdivision of a district.

        Example: Minden-Lübbecke

      • postalCode

        public final Double postalCode()

        An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should posses.

        Returns:
        An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should posses.
      • block

        public final Double block()

        Name of the block.

        Example: Sunny Mansion 203 block: 2 Chome

        Returns:
        Name of the block.

        Example: Sunny Mansion 203 block: 2 Chome

      • subBlock

        public final Double subBlock()

        Name of sub-block.

        Example: Sunny Mansion 203 sub-block: 4

        Returns:
        Name of sub-block.

        Example: Sunny Mansion 203 sub-block: 4

      • hasIntersection

        public final boolean hasIntersection()
        For responses, this returns true if the service returned a value for the Intersection property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • intersection

        public final List<Double> intersection()

        Name of the streets in the intersection.

        Example: ["Friedrichstraße","Unter den Linden"]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIntersection() method.

        Returns:
        Name of the streets in the intersection.

        Example: ["Friedrichstraße","Unter den Linden"]

      • addressNumber

        public final Double addressNumber()

        The house number or address results should have.

        Returns:
        The house number or address results should have.
      • building

        public final Double building()

        The name of the building at the address.

        Returns:
        The name of the building at the address.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)