android-location-provider

A pack of helpful helpers to obtain location(s) from fused location provider.

Installation

Add https://jitpack.io to your build.gradle with:

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

add android-location-provider dependency into your project

dependencies {
    implementtation 'com.github.lykmapipo:android-location-provider:v0.4.0'
}

Usage

In activity(or other component) request for last and location updates

public class MainActivity extends AppCompatActivity {

    private static final String TAG = MainActivity.class.getSimpleName();
    private TextView tvLongitude;
    private TextView tvLatitude;
    private TextView tvAddress;
    private Location lastKnownLocation;

    @SuppressLint("MissingPermission")
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // request last known location
        tvLongitude = findViewById(R.id.tvLongitude);
        tvLatitude = findViewById(R.id.tvLatitude);
        tvAddress = findViewById(R.id.tvAddress);
        Button btnRequestLastLocation = findViewById(R.id.btnRequestLastLocation);
        btnRequestLastLocation.setOnClickListener(v -> LocationProvider.requestLastLocation(this, new LocationProvider.OnLastLocationListener() {
            @Override
            public void onSuccess(Location location) {
                Toast.makeText(MainActivity.this, "Location Success: " + location.toString(), Toast.LENGTH_SHORT).show();
                lastKnownLocation = location;
                double longitude = location.getLongitude();
                double latitude = location.getLatitude();
                tvLatitude.setText(format("Latitude", latitude));
                tvLongitude.setText(format("Longitude", longitude));
            }

            @Override
            public void onFailure(Exception error) {
                Toast.makeText(MainActivity.this, "Location Failed: " + error.getMessage(), Toast.LENGTH_SHORT).show();
            }
        }));

        // request address
        Button btnRequestAddress = findViewById(R.id.btnRequestAddress);
        btnRequestAddress.setOnClickListener(v -> {
            if (lastKnownLocation != null) {
                LocationProvider.requestAddress(this, lastKnownLocation, new LocationProvider.OnAddressListener() {

                    @Override
                    public void onSuccess(Address address) {
                        Toast.makeText(MainActivity.this, "Address Success: " + address.toString(), Toast.LENGTH_SHORT).show();
                        tvAddress.setText(format("Address", address.getAdminArea(), address.getCountryName()));
                    }

                    @Override
                    public void onFailure(Exception error) {
                        Toast.makeText(MainActivity.this, "Address Failed: " + error.getMessage(), Toast.LENGTH_SHORT).show();
                    }
                });
            }
        });

        // request location updates
        Button btnRequestLocationUpdates = findViewById(R.id.btnRequestLocationUpdates);
        btnRequestLocationUpdates.setOnClickListener(v -> LocationProvider.requestLocationUpdates(this, new LocationProvider.OnLocationUpdatesListener() {
            @Override
            public void onSuccess(LocationResult result) {
                // obtain latest location
                Location location = result.getLastLocation();

                Toast.makeText(MainActivity.this, "Location Updates Success: " + location.toString(), Toast.LENGTH_SHORT).show();
                double longitude = location.getLongitude();
                double latitude = location.getLatitude();
                tvLatitude.setText(format("Latitude", latitude));
                tvLongitude.setText(format("Longitude", longitude));
            }

            @Override
            public void onFailure(Exception error) {
                Toast.makeText(MainActivity.this, "Location Updates Failed: " + error.getMessage(), Toast.LENGTH_SHORT).show();
            }
        }));

        // stop location updates
        Button btnStopLocationUpdates = findViewById(R.id.btnStopLocationUpdates);
        btnStopLocationUpdates.setOnClickListener(view -> {
            LocationProvider.stopLocationUpdates();
            Toast.makeText(MainActivity.this, "Location Updates Stopped Successfully", Toast.LENGTH_SHORT).show();

        });
    }

    @Override
    protected void onPause() {
        super.onPause();
        LocationProvider.stopLocationUpdates();
    }

    private String format(@NonNull String label, @NonNull double value) {
        return String.format(Locale.ENGLISH, "%s: %f", label, value);
    }

    private String format(@NonNull String label, @NonNull String... value) {
        String s = TextUtils.join(", ", value);
        return String.format(Locale.ENGLISH, "%s: %s", label, s);
    }
}

Test

./gradlew test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

License

(The MIT License)

Copyright (c) lykmapipo && Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.