Interface GeocodeResultItem.Builder

    • Method Detail

      • placeId

        GeocodeResultItem.Builder placeId​(String placeId)

        The PlaceId of the place you wish to receive the information for.

        Parameters:
        placeId - The PlaceId of the place you wish to receive the information for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • placeType

        GeocodeResultItem.Builder placeType​(String placeType)

        A PlaceType is a category that the result place must belong to.

        Parameters:
        placeType - A PlaceType is a category that the result place must belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PlaceType, PlaceType
      • placeType

        GeocodeResultItem.Builder placeType​(PlaceType placeType)

        A PlaceType is a category that the result place must belong to.

        Parameters:
        placeType - A PlaceType is a category that the result place must belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PlaceType, PlaceType
      • title

        GeocodeResultItem.Builder title​(String title)

        The localized display name of this result item based on request parameter language.

        Parameters:
        title - The localized display name of this result item based on request parameter language.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • address

        GeocodeResultItem.Builder address​(Address address)

        The place's address.

        Parameters:
        address - The place's address.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • addressNumberCorrected

        GeocodeResultItem.Builder addressNumberCorrected​(Boolean addressNumberCorrected)

        Boolean indicating if the address provided has been corrected.

        Parameters:
        addressNumberCorrected - Boolean indicating if the address provided has been corrected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • postalCodeDetails

        GeocodeResultItem.Builder postalCodeDetails​(Collection<PostalCodeDetails> postalCodeDetails)

        Contains details about the postal code of the place/result.

        Parameters:
        postalCodeDetails - Contains details about the postal code of the place/result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • postalCodeDetails

        GeocodeResultItem.Builder postalCodeDetails​(PostalCodeDetails... postalCodeDetails)

        Contains details about the postal code of the place/result.

        Parameters:
        postalCodeDetails - Contains details about the postal code of the place/result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • position

        GeocodeResultItem.Builder position​(Collection<Double> position)

        The position in longitude and latitude.

        Parameters:
        position - The position in longitude and latitude.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • position

        GeocodeResultItem.Builder position​(Double... position)

        The position in longitude and latitude.

        Parameters:
        position - The position in longitude and latitude.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • distance

        GeocodeResultItem.Builder distance​(Long distance)

        The distance in meters from the QueryPosition.

        Parameters:
        distance - The distance in meters from the QueryPosition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • mapView

        GeocodeResultItem.Builder mapView​(Collection<Double> mapView)

        The bounding box enclosing the geometric shape (area or line) that an individual result covers.

        The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

        Parameters:
        mapView - The bounding box enclosing the geometric shape (area or line) that an individual result covers.

        The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

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

        GeocodeResultItem.Builder mapView​(Double... mapView)

        The bounding box enclosing the geometric shape (area or line) that an individual result covers.

        The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

        Parameters:
        mapView - The bounding box enclosing the geometric shape (area or line) that an individual result covers.

        The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

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

        GeocodeResultItem.Builder categories​(Collection<Category> categories)

        Categories of results that results must belong to.

        Parameters:
        categories - Categories of results that results must belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • categories

        GeocodeResultItem.Builder categories​(Category... categories)

        Categories of results that results must belong to.

        Parameters:
        categories - Categories of results that results must belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • foodTypes

        GeocodeResultItem.Builder foodTypes​(Collection<FoodType> foodTypes)

        List of food types offered by this result.

        Parameters:
        foodTypes - List of food types offered by this result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • foodTypes

        GeocodeResultItem.Builder foodTypes​(FoodType... foodTypes)

        List of food types offered by this result.

        Parameters:
        foodTypes - List of food types offered by this result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • accessPoints

        GeocodeResultItem.Builder accessPoints​(Collection<AccessPoint> accessPoints)

        Position of the access point represent by longitude and latitude.

        Parameters:
        accessPoints - Position of the access point represent by longitude and latitude.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • accessPoints

        GeocodeResultItem.Builder accessPoints​(AccessPoint... accessPoints)

        Position of the access point represent by longitude and latitude.

        Parameters:
        accessPoints - Position of the access point represent by longitude and latitude.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • timeZone

        GeocodeResultItem.Builder timeZone​(TimeZone timeZone)

        The time zone in which the place is located.

        Parameters:
        timeZone - The time zone in which the place is located.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • politicalView

        GeocodeResultItem.Builder politicalView​(String politicalView)

        The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

        Parameters:
        politicalView - The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • matchScores

        GeocodeResultItem.Builder matchScores​(MatchScoreDetails matchScores)

        Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

        Parameters:
        matchScores - Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
        Returns:
        Returns a reference to this object so that method calls can be chained together.