CarmenFeature (services 4.2.0-SNAPSHOT API)

java.lang.Object
- com.mapbox.api.geocoding.v5.models.CarmenFeature

All Implemented Interfaces:

com.mapbox.geojson.GeoJson, java.io.Serializable
```
public abstract class CarmenFeature
extends java.lang.Object
implements com.mapbox.geojson.GeoJson, java.io.Serializable
```
The Features key in the geocoding API response contains the majority of information you'll want to use. It extends the GeoJson object in GeoJSON and adds several additional attribute which further describe the geocoding result.
A Geocoding id is a String in the form {type}.{id} where {type} is the lowest hierarchy feature in the place_type field. The {id} suffix of the feature id is unstable and may change within versions.
Note: this class doesn't actually extend Feature due to the inherit rule in AutoValue (see link below).

Since:

1.0.0

See Also:

Carmen Geojson information, Mapbox geocoder documentation, Official GeoJson Feature Specifications, AutoValue inherit rule, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CarmenFeature.Builder
This builder can be used to set the values describing the CarmenFeature.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CarmenFeature.Builder` This builder can be used to set the values describing the `CarmenFeature`.

Constructor Summary

Constructors
Constructor and Description

CarmenFeature()

Constructors
Constructor and Description
`CarmenFeature()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.String`	`address()` A string of the house number for the returned `address` feature.
`abstract com.mapbox.geojson.BoundingBox`	`bbox()` A `CarmenFeature` might have a member named `bbox` to include information on the coordinate range for it's `Geometry`.
`static CarmenFeature.Builder`	`builder()` Create a new instance of this class by using the `CarmenFeature.Builder` class.
`com.mapbox.geojson.Point`	`center()` A `Point` object which represents the center point inside the `bbox()` if one is provided.
`abstract java.util.List<CarmenContext>`	`context()` A list representing the hierarchy of encompassing parent features.
`static CarmenFeature`	`fromJson(java.lang.String json)` Create a CarmenFeature object from JSON.
`abstract com.mapbox.geojson.Geometry`	`geometry()` The geometry which makes up this feature.
`abstract java.lang.String`	`id()` A feature may have a commonly used identifier which is either a unique String or number.
`abstract java.lang.String`	`language()` A string of the IETF language tag of the query's primary language.
`abstract java.lang.String`	`matchingPlaceName()` A string analogous to the `placeName()` field that more closely matches the query than results in the specified language.
`abstract java.lang.String`	`matchingText()` A string analogous to the `text()` field that more closely matches the query than results in the specified language.
`abstract java.lang.String`	`placeName()` A string representing the feature in the requested language, if specified, and its full result hierarchy.
`abstract java.util.List<java.lang.String>`	`placeType()` A list of feature types describing the feature.
`abstract com.google.gson.JsonObject`	`properties()` This contains the JSON object which holds the feature properties.
`abstract java.lang.Double`	`relevance()` A numerical score from 0 (least relevant) to 0.99 (most relevant) measuring how well each returned feature matches the query.
`abstract java.lang.String`	`text()` A string representing the feature in the requested language, if specified.
`abstract CarmenFeature.Builder`	`toBuilder()` Convert current instance values into another Builder to quickly change one or more values.
`java.lang.String`	`toJson()` This takes the currently defined values found inside this instance and converts it to a JSON string.
`abstract java.lang.String`	`type()` This describes the TYPE of GeoJson geometry this object is, thus this will always return `Feature`.
`static com.google.gson.TypeAdapter<CarmenFeature>`	`typeAdapter(com.google.gson.Gson gson)` Gson type adapter for parsing Gson to this class.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CarmenFeature
```
public CarmenFeature()
```
- Method Detail
  - fromJson
```
@NonNull
public static CarmenFeature fromJson(@NonNull
                                              java.lang.String json)
```
    Create a CarmenFeature object from JSON.
    
    Parameters:
    
    json - string of JSON making up a carmen feature
    
    Returns:
    
    this class using the defined information in the provided JSON string
    
    Since:
    
    2.0.0
  - builder
```
@NonNull
public static CarmenFeature.Builder builder()
```
    Create a new instance of this class by using the CarmenFeature.Builder class.
    
    Returns:
    
    this classes CarmenFeature.Builder for creating a new instance
    
    Since:
    
    3.0.0
  - type
```
@NonNull
 @SerializedName(value="type")
public abstract java.lang.String type()
```
    This describes the TYPE of GeoJson geometry this object is, thus this will always return Feature.
    
    Specified by:
    
    type in interface com.mapbox.geojson.GeoJson
    
    Returns:
    
    a String which describes the TYPE of geometry, for this object it will always return Feature
    
    Since:
    
    1.0.0
  - bbox
```
@Nullable
public abstract com.mapbox.geojson.BoundingBox bbox()
```
    A CarmenFeature might have a member named bbox to include information on the coordinate range for it's Geometry. The value of the bbox member MUST be a list of size 2*n where n is the number of dimensions represented in the contained feature geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
    
    Specified by:
    
    bbox in interface com.mapbox.geojson.GeoJson
    
    Returns:
    
    a BoundingBox object containing the information
    
    Since:
    
    3.0.0
  - id
```
@Nullable
public abstract java.lang.String id()
```
    A feature may have a commonly used identifier which is either a unique String or number.
    
    Returns:
    
    a String containing this features unique identification or null if one wasn't given during creation.
    
    Since:
    
    1.0.0
  - geometry
```
@Nullable
public abstract com.mapbox.geojson.Geometry geometry()
```
    The geometry which makes up this feature. A Geometry object represents points, curves, and surfaces in coordinate space. One of the seven geometries provided inside this library can be passed in through one of the static factory methods.
    
    Returns:
    
    a single defined Geometry which makes this feature spatially aware
    
    Since:
    
    1.0.0
  - properties
```
@Nullable
public abstract com.google.gson.JsonObject properties()
```
    This contains the JSON object which holds the feature properties. The value of the properties member is a JsonObject and might be empty if no properties are provided.
    
    Returns:
    
    a JsonObject which holds this features current properties
    
    Since:
    
    1.0.0
  - text
```
@Nullable
public abstract java.lang.String text()
```
    A string representing the feature in the requested language, if specified.
    
    Returns:
    
    text representing the feature (e.g. "Austin")
    
    Since:
    
    1.0.0
  - placeName
```
@Nullable
 @SerializedName(value="place_name")
public abstract java.lang.String placeName()
```
    A string representing the feature in the requested language, if specified, and its full result hierarchy.
    
    Returns:
    
    human-readable text representing the full result hierarchy (e.g. "Austin, Texas, United States")
    
    Since:
    
    1.0.0
  - placeType
```
@Nullable
 @SerializedName(value="place_type")
public abstract java.util.List<java.lang.String> placeType()
```
    A list of feature types describing the feature. Options are one of the following types defined in the GeocodingCriteria.GeocodingTypeCriteria. Most features have only one type, but if the feature has multiple types, (for example, Vatican City is a country, region, and place), all applicable types will be provided in the list.
    
    Returns:
    
    a list containing the place type
    
    Since:
    
    1.0.0
  - address
```
@Nullable
public abstract java.lang.String address()
```
    A string of the house number for the returned address feature. Note that unlike the address property for poi features, this property is outside the properties object.
    
    Returns:
    
    while the string content isn't guaranteed, and might return null, in many cases, this will be the house number
    
    Since:
    
    1.0.0
  - center
```
@Nullable
public com.mapbox.geojson.Point center()
```
    A Point object which represents the center point inside the bbox() if one is provided.
    
    Returns:
    
    a GeoJson Point which defines the center location of this feature
    
    Since:
    
    1.0.0
  - context
```
@Nullable
public abstract java.util.List<CarmenContext> context()
```
    A list representing the hierarchy of encompassing parent features. This is where you can find telephone, address, and other information pertaining to this feature.
    
    Returns:
    
    a list made up of CarmenContext which might contain additional information about this specific feature
    
    Since:
    
    1.0.0
  - relevance
```
@Nullable
public abstract java.lang.Double relevance()
```
    A numerical score from 0 (least relevant) to 0.99 (most relevant) measuring how well each returned feature matches the query. You can use this property to remove results which don't fully match the query.
    
    Returns:
    
    the relevant score between 0 and 1
    
    Since:
    
    1.0.0
  - matchingText
```
@Nullable
 @SerializedName(value="matching_text")
public abstract java.lang.String matchingText()
```
    A string analogous to the text() field that more closely matches the query than results in the specified language. For example, querying "Köln, Germany" with language set to English might return a feature with the text() "Cologne" and this would be "Köln".
    
    Returns:
    
    a string containing the matching text
    
    Since:
    
    2.2.0
  - matchingPlaceName
```
@Nullable
 @SerializedName(value="matching_place_name")
public abstract java.lang.String matchingPlaceName()
```
    A string analogous to the placeName() field that more closely matches the query than results in the specified language. For example, querying "Köln, Germany" with language set to English might return a feature with the placeName() "Cologne, Germany" and this would return "Köln, North Rhine-Westphalia, Germany".
    
    Returns:
    
    a string containing the matching place name
    
    Since:
    
    2.2.0
  - language
```
@Nullable
public abstract java.lang.String language()
```
    A string of the IETF language tag of the query's primary language.
    
    Returns:
    
    string containing the query's primary language
    
    Since:
    
    2.2.0
    
    See Also:
    
    IETF language tag Wikipedia page
  - typeAdapter
```
public static com.google.gson.TypeAdapter<CarmenFeature> typeAdapter(com.google.gson.Gson gson)
```
    Gson type adapter for parsing Gson to this class.
    
    Parameters:
    
    gson - the built Gson object
    
    Returns:
    
    the type adapter for this class
    
    Since:
    
    3.0.0
  - toJson
```
public java.lang.String toJson()
```
    This takes the currently defined values found inside this instance and converts it to a JSON string.
    
    Specified by:
    
    toJson in interface com.mapbox.geojson.GeoJson
    
    Returns:
    
    a JSON string which represents this CarmenFeature
    
    Since:
    
    3.0.0
  - toBuilder
```
public abstract CarmenFeature.Builder toBuilder()
```
    Convert current instance values into another Builder to quickly change one or more values.
    
    Returns:
    
    a new instance of CarmenFeature using the newly defined values
    
    Since:
    
    3.0.0

Class CarmenFeature

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CarmenFeature

Method Detail

fromJson

builder

type

bbox

id

geometry

properties

text

placeName

placeType

address

center

context

relevance

matchingText

matchingPlaceName

language

typeAdapter

toJson

toBuilder