UnifiedNlp/compat/current/src/com/android/location/provider/GeocodeProvider.java
2015-01-02 19:59:03 +01:00

65 lines
2.5 KiB
Java

/*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.location.provider;
import android.location.Address;
import android.location.GeocoderParams;
import android.os.IBinder;
import java.util.List;
/**
* Base class for geocode providers implemented as unbundled services.
* <p/>
* <p>Geocode providers can be implemented as services and return the result of
* {@link GeocodeProvider#getBinder()} in its getBinder() method.
* <p/>
* <p>IMPORTANT: This class is effectively a public API for unbundled
* applications, and must remain API stable. See README.txt in the root
* of this package for more information.
*/
public abstract class GeocodeProvider {
/**
* This method is overridden to implement the
* {@link android.location.Geocoder#getFromLocation(double, double, int)} method.
* Classes implementing this method should not hold a reference to the params parameter.
*/
public abstract String onGetFromLocation(double latitude, double longitude, int maxResults,
GeocoderParams params, List<Address> addrs);
/**
* This method is overridden to implement the
* {@link android.location.Geocoder#getFromLocationName(String, int, double, double, double, double)} method.
* Classes implementing this method should not hold a reference to the params parameter.
*/
public abstract String onGetFromLocationName(String locationName,
double lowerLeftLatitude, double lowerLeftLongitude,
double upperRightLatitude, double upperRightLongitude, int maxResults,
GeocoderParams params, List<Address> addrs);
/**
* Returns the Binder interface for the geocode provider.
* This is intended to be used for the onBind() method of
* a service that implements a geocoder service.
*
* @return the IBinder instance for the provider
*/
public IBinder getBinder() {
return null;
}
}