public
class
ReverseGeocodingRequest
extends Object| java.lang.Object | |
| ↳ | com.carto.geocoding.ReverseGeocodingRequest |
Class Overview
A reverse geocoding request describing search location.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
ReverseGeocodingRequest(Projection projection, MapPos location)
Constructs a new ReverseGeocodingRequest object from a projection and location.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| boolean |
equals(Object obj)
Checks if this object is equal to the specified object.
| ||||||||||
| Variant |
getCustomParameter(String param)
Returns the custom parameter value of the request.
| ||||||||||
| MapPos |
getLocation()
Returns the location of the query.
| ||||||||||
| Projection |
getProjection()
Returns the projection of the query.
| ||||||||||
| float |
getSearchRadius()
Returns the search radius (in meters).
| ||||||||||
| int |
hashCode()
Returns the hash value of this object.
| ||||||||||
| void |
setCustomParameter(String param, Variant value)
Sets a custom parameter value for the the request.
| ||||||||||
| void |
setSearchRadius(float radius)
Sets the search radius (in meters).
| ||||||||||
| String |
toString()
Creates a string representation of this request object, useful for logging.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public ReverseGeocodingRequest (Projection projection, MapPos location)
Constructs a new ReverseGeocodingRequest object from a projection and location.
Parameters
| projection | The projection to use for the result and location data. |
|---|---|
| location | The location of the query. |
Public Methods
public synchronized void delete ()
public boolean equals (Object obj)
Checks if this object is equal to the specified object.
Parameters
| obj | The reference object. |
|---|
Returns
- True when objects are equal, false otherwise.
public Variant getCustomParameter (String param)
Returns the custom parameter value of the request.
Parameters
| param | The name of the parameter to return. |
|---|
Returns
- The value of the parameter. If the parameter does not exist, empty variant is returned.
public Projection getProjection ()
Returns the projection of the query.
Returns
- The projection of the query.
public float getSearchRadius ()
Returns the search radius (in meters).
Returns
- The search radius in meters.
public int hashCode ()
Returns the hash value of this object.
Returns
- The hash value of this object.
public void setCustomParameter (String param, Variant value)
Sets a custom parameter value for the the request.
Parameters
| param | The name of the parameter. |
|---|---|
| value | The new value for the parameter. |
public void setSearchRadius (float radius)
Sets the search radius (in meters).
The default search radius is 100 meters.
Parameters
| radius | The new search radius in meters. |
|---|
public String toString ()
Creates a string representation of this request object, useful for logging.
Returns
- The string representation of this request object.