Geocoding.java

package com.baseflow.geocoding;

import androidx.annotation.Nullable;

import android.content.Context;
import android.location.Address;
import android.location.Geocoder;
import android.os.Build;

import androidx.annotation.RequiresApi;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;


/**
 * Geocoding components to lookup address or coordinates.
 */
class Geocoding {
    private final Context androidContext;
    @Nullable
    private Locale locale;

    /**
     * Uses the given {@code androidContext} to execute geocoding features
     *
     * @param androidContext the context to use when requesting geocoding features
     */
    Geocoding(Context androidContext) {
        this.androidContext = androidContext;
    }

    void setLocaleIdentifier(@Nullable Locale locale) {
        this.locale = locale;
    }

     /**
     * Returns true if there is a geocoder implementation present that may return results. 
     * If true, there is still no guarantee that any individual geocoding attempt will succeed.
     *
     */
     boolean isPresent() {
        return Geocoder.isPresent();
    }

    /**
     * Returns a list of Address objects matching the supplied address string.
     *
     * @param address the address string for the search
     * @param callback the GeocodeListenerAdapter that listens for success or error
     * @return a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.
     */
    void placemarkFromAddress(
        String address,
        Double lowerLeftLatitude,
        Double lowerLeftLongitude,
        Double upperRightLatitude,
        Double upperRightLongitude,
        GeocodeListenerAdapter callback
    ) {
        final Geocoder geocoder = createGeocoder(androidContext, locale);

        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
            getAddressesWithGeocodeListener(
                geocoder,
                address,
                5,
                lowerLeftLatitude,
                lowerLeftLongitude,
                upperRightLatitude,
                upperRightLongitude,
                callback
            );
        } else {
            try {
                List<Address> addresses = deprecatedGetFromLocationName(
                    geocoder,
                    address,
                    lowerLeftLatitude,
                    lowerLeftLongitude,
                    upperRightLatitude,
                    upperRightLongitude
                );
                callback.onGeocode(addresses);
            } catch (IOException ex) {
                callback.onError(ex.getMessage());
            }
        }
    }

    @SuppressWarnings("deprecation")
    private List<Address> deprecatedGetFromLocationName(
        Geocoder geocoder,
        String address,
        Double lowerLeftLatitude,
        Double lowerLeftLongitude,
        Double upperRightLatitude,
        Double upperRightLongitude
    ) throws IOException {
        if (lowerLeftLatitude == null || lowerLeftLongitude == null || upperRightLatitude == null || upperRightLongitude == null) {
            return geocoder.getFromLocationName(address, 5);
        } else {
            return geocoder.getFromLocationName(address, 5, lowerLeftLatitude, lowerLeftLongitude, upperRightLatitude, upperRightLongitude);
        }
    }

    @RequiresApi(api = Build.VERSION_CODES.TIRAMISU)
    private void getAddressesWithGeocodeListener(
        Geocoder geocoder,
        String address,
        int maxResults,
        Double lowerLeftLatitude,
        Double lowerLeftLongitude,
        Double upperRightLatitude,
        Double upperRightLongitude,
        GeocodeListenerAdapter callback
    ) {
        final Geocoder.GeocodeListener listener = new Geocoder.GeocodeListener() {
            @Override
            public void onGeocode(List<Address> geocodedAddresses) {
                callback.onGeocode(geocodedAddresses);
            }

            @Override
            public void onError(@Nullable String errorMessage) {
                callback.onError(errorMessage);
            }
        };
        if (lowerLeftLatitude == null || lowerLeftLongitude == null || upperRightLatitude == null || upperRightLongitude == null) {
            geocoder.getFromLocationName(address, maxResults, listener);
        } else {
            geocoder.getFromLocationName(address, maxResults, lowerLeftLatitude, lowerLeftLongitude, upperRightLatitude, upperRightLongitude, listener);
        }
    }


    /**
     * Returns a list of Address objects matching the supplied coordinates.
     *
     * @param latitude  the latitude point for the search
     * @param longitude the longitude point for the search
     * @param callback the GeocodeListenerAdapter that listens for success or error
     * @return a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.
     */
    void placemarkFromCoordinates(
            double latitude,
            double longitude,
            GeocodeListenerAdapter callback
    ) {
        final Geocoder geocoder = createGeocoder(androidContext, locale);
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
            getLocationWithGeocodeListener(geocoder, latitude, longitude, 5, callback);
        } else {
            try {
                List<Address> addresses = deprecatedGetFromLocation(geocoder, latitude, longitude);
                callback.onGeocode(addresses);
            } catch (IOException ex) {
                callback.onError(ex.getMessage());
            }}
    }

    @SuppressWarnings("deprecation")
    private List<Address> deprecatedGetFromLocation(Geocoder geocoder,
                                                    double latitude,
                                                    double longitude) throws IOException {
        return geocoder.getFromLocation(latitude, longitude, 5);
    }

    @RequiresApi(api = Build.VERSION_CODES.TIRAMISU)
    private void getLocationWithGeocodeListener(Geocoder geocoder, double latitude, double longitude, int maxResults, GeocodeListenerAdapter callback) {
        geocoder.getFromLocation(latitude, longitude, maxResults, new Geocoder.GeocodeListener() {
            @Override
            public void onGeocode(List<Address> geocodedAddresses) {
                callback.onGeocode(geocodedAddresses);
            }

            @Override
            public void onError(@Nullable String errorMessage) {
                callback.onError(errorMessage);
            }
        });
    }

    private static Geocoder createGeocoder(Context androidContext, @Nullable Locale locale) {
        return (locale != null)
                ? new Geocoder(androidContext, locale)
                : new Geocoder(androidContext);
    }
}