public abstract class CarmenContext
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
CarmenContext.Builder
This builder can be used to set the values describing the
CarmenFeature . |
Constructor and Description |
---|
CarmenContext() |
Modifier and Type | Method and Description |
---|---|
static CarmenContext.Builder |
builder()
Create a new instance of this class by using the
CarmenContext.Builder class. |
abstract java.lang.String |
category()
provides the categories that define this features POI if applicable.
|
static CarmenContext |
fromJson(java.lang.String json)
Create a CarmenContext object from JSON.
|
abstract java.lang.String |
id()
ID of the feature of the form {index}.{id} where index is the id/handle of the data-source
that contributed the result.
|
abstract java.lang.String |
maki()
Suggested icon mapping from the most current version of the Maki project for a poi feature,
based on its category.
|
abstract java.lang.String |
shortCode()
The ISO 3166-1 country and ISO 3166-2 region code for the returned feature.
|
abstract java.lang.String |
text()
A string representing the feature.
|
abstract CarmenContext.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.
|
static com.google.gson.TypeAdapter<CarmenContext> |
typeAdapter(com.google.gson.Gson gson)
Gson type adapter for parsing Gson to this class.
|
abstract java.lang.String |
wikidata()
The WikiData identifier for a country, region or place.
|
public static CarmenContext.Builder builder()
CarmenContext.Builder
class.CarmenContext.Builder
for creating a new instancepublic static CarmenContext fromJson(@NonNull java.lang.String json)
json
- string of JSON making up a carmen context@Nullable public abstract java.lang.String id()
@Nullable public abstract java.lang.String text()
@Nullable @SerializedName(value="short_code") public abstract java.lang.String shortCode()
@Nullable public abstract java.lang.String wikidata()
@Nullable public abstract java.lang.String category()
@Nullable public abstract java.lang.String maki()
public static com.google.gson.TypeAdapter<CarmenContext> typeAdapter(com.google.gson.Gson gson)
gson
- the built Gson
objectpublic java.lang.String toJson()
public abstract CarmenContext.Builder toBuilder()
CarmenContext
using the newly defined values