LanguageRange

MAX_WEIGHT

static val MAX_WEIGHT: Double

A constant holding the maximum value of weight, 1.0, which indicates that the language range is a good fit for the user.

Value: 1.0

MIN_WEIGHT

static val MIN_WEIGHT: Double

A constant holding the minimum value of weight, 0.0, which indicates that the language range is not a good fit for the user.

Value: 0.0

LanguageRange

LanguageRange(range: String)

Constructs a LanguageRange using the given range. Note that no validation is done against the IANA Language Subtag Registry at time of construction.

This is equivalent to LanguageRange(range, MAX_WEIGHT).

LanguageRange

LanguageRange(
    range: String, 
    weight: Double)

Constructs a LanguageRange using the given range and weight. Note that no validation is done against the IANA Language Subtag Registry at time of construction.

equals

fun equals(other: Any?): Boolean

Compares this object to the specified object. The result is true if and only if the argument is not null and is a LanguageRange object that contains the same range and weight values as this object.

getRange

fun getRange(): String

Returns the language range of this LanguageRange.

getWeight

fun getWeight(): Double

Returns the weight of this LanguageRange.

hashCode

fun hashCode(): Int

{@return a hash code value for this object}

mapEquivalents

static fun mapEquivalents(
    priorityList: MutableList<Locale.LanguageRange!>, 
    map: MutableMap<String!, MutableList<String!>!>
): MutableList<Locale.LanguageRange!>

Generates a new customized Language Priority List using the given priorityList and map. If the given map is empty, this method returns a copy of the given priorityList.

In the map, a key represents a language range whereas a value is a list of equivalents of it. '*' cannot be used in the map. Each equivalent language range has the same weight value as its original language range.

An example of map:
     <b>Key</b><b>Value</b>"zh" (Chinese)                 "zh",
                                      "zh-Hans"(Simplified Chinese)
       "zh-HK" (Chinese, Hong Kong)   "zh-HK"
       "zh-TW" (Chinese, Taiwan)      "zh-TW"
  

For example, if a user's Language Priority List consists of five language ranges ("zh", "zh-CN", "en", "zh-TW", and "zh-HK"), the newly generated Language Priority List which is customized using the above map example will consists of "zh", "zh-Hans", "zh-CN", "zh-Hans-CN", "en", "zh-TW", and "zh-HK".

"zh-HK" and "zh-TW" aren't converted to "zh-Hans-HK" nor "zh-Hans-TW" even if they are included in the Language Priority List. In this example, mapping is used to clearly distinguish Simplified Chinese and Traditional Chinese.

If the "zh"-to-"zh" mapping isn't included in the map, a simple replacement will be performed and the customized list won't include "zh" and "zh-CN".

parse

static fun parse(ranges: String): MutableList<Locale.LanguageRange!>

Parses the given ranges to generate a Language Priority List.

This method performs a syntactic check for each language range in the given ranges but doesn't do validation using the IANA Language Subtag Registry.

The ranges to be given can take one of the following forms:

"Accept-Language: ja,en;q=0.4"  (weighted list with Accept-Language prefix)
    "ja,en;q=0.4"                   (weighted list)
    "ja,en"                         (prioritized list)
  

Unlike a weighted list, language ranges in a prioritized list are sorted in the descending order based on its priority. The first language range has the highest priority and meets the user's preference most.

In either case, language ranges are sorted in descending order in the Language Priority List based on priority or weight. If a language range appears in the given ranges more than once, only the first one is included on the Language Priority List.

The returned list consists of language ranges from the given ranges and their equivalents found in the IANA Language Subtag Registry. For example, if the given ranges is "Accept-Language: iw,en-us;q=0.7,en;q=0.3", the elements in the list to be returned are:

<b>Range</b><b>Weight</b>"iw" (older tag for Hebrew)             1.0
     "he" (new preferred code for Hebrew)    1.0
     "en-us" (English, United States)        0.7
     "en" (English)                          0.3
  

parse

static fun parse(
    ranges: String, 
    map: MutableMap<String!, MutableList<String!>!>
): MutableList<Locale.LanguageRange!>

Parses the given ranges to generate a Language Priority List, and then customizes the list using the given map. This method is equivalent to mapEquivalents(parse(ranges), map).

toString

fun toString(): String

Returns an informative string representation of this LanguageRange object, consisting of language range and weight if the range is weighted and the weight is less than the max weight.