MapLocale (plugin-localization API)

java.lang.Object
- com.mapbox.mapboxsdk.plugins.localization.MapLocale

```
public final class MapLocale
extends java.lang.Object
```
A MapLocale object builds off of the Locale object and provides additional geographical information particular to the Mapbox Maps SDK. Like Locale, MapLocale can be used to make the map locale sensitive.
The MapLocale object can be used to acquire the matching Locale's map language; useful for translating the map language into one of the supported ones found in MapLocale.Languages.
You'll also be able to get bounding box information for that same country so the map's starting position target can adjust itself over the device's Locale country.
A handful of MapLocale's are already constructed and offered through this class as static variables. If a country is missing and you'd like to add it, you can use one of the MapLocale constructors to build a valid map locale. Once this is done, you need to add it to the Locale cache using addMapLocale(Locale, MapLocale) where the first parameter is the Locale object which matches up with your newly created MapLocale.

Since:

0.1.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MapLocale.Languages

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MapLocale.Languages`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARABIC` Arabic (if available)
`static MapLocale`	`BRAZIL` Useful constant for country.
`static MapLocale`	`CANADA` Useful constant for country.
`static MapLocale`	`CANADA_FRENCH` Useful constant for country.
`static MapLocale`	`CHINA` Useful constant for country.
`static java.lang.String`	`CHINESE` Chinese (if available)
`static MapLocale`	`CHINESE_HANS` Useful constant for country.
`static MapLocale`	`CHINESE_HANT` Useful constant for country.
`static java.lang.String`	`ENGLISH` English (if available)
`static MapLocale`	`FRANCE` Useful constant for country.
`static java.lang.String`	`FRENCH` French (if available)
`static java.lang.String`	`GERMAN` German (if available)
`static MapLocale`	`GERMANY` Useful constant for country.
`static MapLocale`	`JAPAN` Useful constant for country.
`static java.lang.String`	`JAPANESE` Japanese (if available)
`static MapLocale`	`KOREA` Useful constant for country.
`static java.lang.String`	`KOREAN` Korean (if available)
`static java.lang.String`	`LOCAL_NAME` The name (or names) used locally for the place.
`static MapLocale`	`PORTUGAL` Useful constant for country.
`static java.lang.String`	`PORTUGUESE` Portuguese (if available)
`static MapLocale`	`RUSSIA` Useful constant for country.
`static java.lang.String`	`RUSSIAN` Russian (if available)
`static java.lang.String`	`SIMPLIFIED_CHINESE` Simplified Chinese (if available)
`static MapLocale`	`SPAIN` Useful constant for country.
`static java.lang.String`	`SPANISH` Spanish (if available)
`static MapLocale`	`TAIWAN` Useful constant for country.
`static MapLocale`	`UK` Useful constant for country.
`static MapLocale`	`US` Useful constant for country.

Constructor Summary

Constructors
Constructor and Description
`MapLocale(com.mapbox.mapboxsdk.geometry.LatLngBounds countryBounds)` Construct a new MapLocale instance by passing in a LatLngBounds object.
`MapLocale(java.lang.String mapLanguage)` Construct a new MapLocale instance using one of the map languages found in `MapLocale.Languages`.
`MapLocale(java.lang.String mapLanguage, com.mapbox.mapboxsdk.geometry.LatLngBounds countryBounds)` /** Construct a new MapLocale instance using one of the map languages found in `MapLocale.Languages` and also passing in a LatLngBounds object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addMapLocale(java.util.Locale locale, MapLocale mapLocale)` When creating a new MapLocale, you'll need to associate a `Locale` so that `Locale.getDefault()` will find the correct corresponding `MapLocale`.
`com.mapbox.mapboxsdk.geometry.LatLngBounds`	`getCountryBounds()` Returns a `LatLngBounds` which represents the viewport bounds which allow for the entire viewing of a country within the devices viewport.
`java.lang.String`	`getMapLanguage()` Returns the Map Language which can be fed directly into `textField` in runtime styling to change language.
`static MapLocale`	`getMapLocale(java.util.Locale locale)` Passing in a Locale, you are able to receive the `MapLocale` object which it is currently paired with.
`static MapLocale`	`getMapLocale(java.util.Locale locale, boolean acceptFallback)` Passing in a Locale, you are able to receive the `MapLocale` object which it is currently paired with.

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

- Field Detail
  - LOCAL_NAME
```
public static final java.lang.String LOCAL_NAME
```
    The name (or names) used locally for the place.
    
    See Also:
    
    Constant Field Values
  - ENGLISH
```
public static final java.lang.String ENGLISH
```
    English (if available)
    
    See Also:
    
    Constant Field Values
  - FRENCH
```
public static final java.lang.String FRENCH
```
    French (if available)
    
    See Also:
    
    Constant Field Values
  - ARABIC
```
public static final java.lang.String ARABIC
```
    Arabic (if available)
    
    See Also:
    
    Constant Field Values
  - SPANISH
```
public static final java.lang.String SPANISH
```
    Spanish (if available)
    
    See Also:
    
    Constant Field Values
  - GERMAN
```
public static final java.lang.String GERMAN
```
    German (if available)
    
    See Also:
    
    Constant Field Values
  - PORTUGUESE
```
public static final java.lang.String PORTUGUESE
```
    Portuguese (if available)
    
    See Also:
    
    Constant Field Values
  - RUSSIAN
```
public static final java.lang.String RUSSIAN
```
    Russian (if available)
    
    See Also:
    
    Constant Field Values
  - CHINESE
```
public static final java.lang.String CHINESE
```
    Chinese (if available)
    
    See Also:
    
    Constant Field Values
  - SIMPLIFIED_CHINESE
```
public static final java.lang.String SIMPLIFIED_CHINESE
```
    Simplified Chinese (if available)
    
    See Also:
    
    Constant Field Values
  - JAPANESE
```
public static final java.lang.String JAPANESE
```
    Japanese (if available)
    
    See Also:
    
    Constant Field Values
  - KOREAN
```
public static final java.lang.String KOREAN
```
    Korean (if available)
    
    See Also:
    
    Constant Field Values
  - FRANCE
```
public static final MapLocale FRANCE
```
    Useful constant for country.
  - GERMANY
```
public static final MapLocale GERMANY
```
    Useful constant for country.
  - JAPAN
```
public static final MapLocale JAPAN
```
    Useful constant for country.
  - KOREA
```
public static final MapLocale KOREA
```
    Useful constant for country.
  - CHINA
```
public static final MapLocale CHINA
```
    Useful constant for country.
  - TAIWAN
```
public static final MapLocale TAIWAN
```
    Useful constant for country.
  - CHINESE_HANS
```
public static final MapLocale CHINESE_HANS
```
    Useful constant for country. General Simplified Chinese
  - CHINESE_HANT
```
public static final MapLocale CHINESE_HANT
```
    Useful constant for country. General Traditional Chinese
  - UK
```
public static final MapLocale UK
```
    Useful constant for country.
  - US
```
public static final MapLocale US
```
    Useful constant for country.
  - CANADA
```
public static final MapLocale CANADA
```
    Useful constant for country.
  - CANADA_FRENCH
```
public static final MapLocale CANADA_FRENCH
```
    Useful constant for country.
  - RUSSIA
```
public static final MapLocale RUSSIA
```
    Useful constant for country.
  - SPAIN
```
public static final MapLocale SPAIN
```
    Useful constant for country.
  - PORTUGAL
```
public static final MapLocale PORTUGAL
```
    Useful constant for country.
  - BRAZIL
```
public static final MapLocale BRAZIL
```
    Useful constant for country.
- Constructor Detail
  - MapLocale
```
public MapLocale(@NonNull
                 java.lang.String mapLanguage)
```
    Construct a new MapLocale instance using one of the map languages found in MapLocale.Languages.
    
    Parameters:
    
    mapLanguage - a non-null string which is allowed from MapLocale.Languages
    
    Since:
    
    0.1.0
  - MapLocale
```
public MapLocale(@NonNull
                 com.mapbox.mapboxsdk.geometry.LatLngBounds countryBounds)
```
    Construct a new MapLocale instance by passing in a LatLngBounds object.
    
    Parameters:
    
    countryBounds - non-null LatLngBounds object which wraps around the country
    
    Since:
    
    0.1.0
  - MapLocale
```
public MapLocale(@NonNull
                 java.lang.String mapLanguage,
                 @Nullable
                 com.mapbox.mapboxsdk.geometry.LatLngBounds countryBounds)
```
    /** Construct a new MapLocale instance using one of the map languages found in MapLocale.Languages and also passing in a LatLngBounds object.
    
    Parameters:
    
    mapLanguage - a non-null string which is allowed from MapLocale.Languages
    
    countryBounds - LatLngBounds object which wraps around the country
    
    Since:
    
    0.1.0
- Method Detail
  - getMapLanguage
```
@NonNull
public java.lang.String getMapLanguage()
```
    Returns the Map Language which can be fed directly into textField in runtime styling to change language.
    
    Returns:
    
    a string representing the map language code.
    
    Since:
    
    0.1.0
  - getCountryBounds
```
@Nullable
public com.mapbox.mapboxsdk.geometry.LatLngBounds getCountryBounds()
```
    Returns a LatLngBounds which represents the viewport bounds which allow for the entire viewing of a country within the devices viewport.
    
    Returns:
    
    a LatLngBounds which can be used when user locations unknown but locale is
    
    Since:
    
    0.1.0
  - addMapLocale
```
public static void addMapLocale(@NonNull
                                java.util.Locale locale,
                                @NonNull
                                MapLocale mapLocale)
```
    When creating a new MapLocale, you'll need to associate a Locale so that Locale.getDefault() will find the correct corresponding MapLocale.
    
    Parameters:
    
    locale - a valid Locale instance shares a 1 to 1 relationship with the MapLocale
    
    mapLocale - the MapLocale which shares a 1 to 1 relationship with the Locale
    
    Since:
    
    0.1.0
  - getMapLocale
```
@Nullable
public static MapLocale getMapLocale(@NonNull
                                               java.util.Locale locale)
```
    Passing in a Locale, you are able to receive the MapLocale object which it is currently paired with. If this returns null, there was no matching MapLocale to go along with the passed in Locale. If you expected a non-null result, you should make sure you used addMapLocale(Locale, MapLocale) before making this call.
    
    Parameters:
    
    locale - the locale which you'd like to receive its matching MapLocale if one exists
    
    Returns:
    
    the created MapLocale
    
    Since:
    
    0.1.0
  - getMapLocale
```
@Nullable
public static MapLocale getMapLocale(@NonNull
                                               java.util.Locale locale,
                                               boolean acceptFallback)
```
    Passing in a Locale, you are able to receive the MapLocale object which it is currently paired with. If this returns null, there was no matching MapLocale to go along with the passed in Locale. If you expected a non-null result, you should make sure you used addMapLocale(Locale, MapLocale) before making this call.
    
    Parameters:
    
    locale - the locale which you'd like to receive its matching MapLocale if one exists
    
    acceptFallback - whether the locale should fallback to the first declared that matches the language, the fallback locale can be added with addMapLocale(Locale, MapLocale)
    
    Returns:
    
    the matching MapLocale if one exists, otherwise null
    
    Since:
    
    0.1.0
    
    See Also:
    
    getMapLocaleFallback(Locale)

Class MapLocale

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCAL_NAME

ENGLISH

FRENCH

ARABIC

SPANISH

GERMAN

PORTUGUESE

RUSSIAN

CHINESE

SIMPLIFIED_CHINESE

JAPANESE

KOREAN

FRANCE

GERMANY

JAPAN

KOREA

CHINA

TAIWAN

CHINESE_HANS

CHINESE_HANT

UK

US

CANADA

CANADA_FRENCH

RUSSIA

SPAIN

PORTUGAL

BRAZIL

Constructor Detail

MapLocale

MapLocale

MapLocale

Method Detail

getMapLanguage

getCountryBounds

addMapLocale

getMapLocale

getMapLocale