play.i18n

Class Lang

java.lang.Object

play.api.i18n.Lang

play.i18n.Lang

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class Lang
extends play.api.i18n.Lang

A Lang supported by the application.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Lang(play.api.i18n.Lang underlyingLang)
Lang(java.util.Locale locale)

Method Summary

Modifier and Type	Method and Description
static java.util.List<Lang>	availables() Deprecated. Please use Lang.availables(app), since 2.5.0
static java.util.List<Lang>	availables(Application app) Retrieve Lang availables from the application configuration.
java.lang.String	code() The language tag (such as fr or en-US).
java.lang.String	country() A valid ISO Country Code.
static Lang	forCode(java.lang.String code) Create a Lang value from a code (such as fr or en-US).
java.lang.String	language() A valid ISO Language Code.
static Lang	preferred(Application app, java.util.List<Lang> langs) Guess the preferred lang in the langs set passed as argument.
static Lang	preferred(java.util.List<Lang> langs) Deprecated. Please use preferred(app, langs). Deprecated since 2.5.0.
java.lang.String	script() The script tag for this Lang
java.util.Locale	toLocale() Convert to a Java Locale value.
java.lang.String	variant() The variant tag for this Lang

Methods inherited from class play.api.i18n.Lang

apply, apply, apply, apply$default$2, apply$default$3, apply$default$4, canEqual, copy, copy$default$1, defaultLang, equals, get, hashCode, jsonOReads, jsonOWrites, jsonTagReads, jsonTagWrites, locale, preferred, productArity, productElement, productIterator, productPrefix, satisfies, toString, unapply

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Lang

public Lang(play.api.i18n.Lang underlyingLang)

Lang

public Lang(java.util.Locale locale)

Method Detail

language

public java.lang.String language()

A valid ISO Language Code.

Overrides:

language in class play.api.i18n.Lang

country

public java.lang.String country()

A valid ISO Country Code.

Overrides:

country in class play.api.i18n.Lang

script

public java.lang.String script()

The script tag for this Lang

Overrides:

script in class play.api.i18n.Lang

variant

public java.lang.String variant()

The variant tag for this Lang

Overrides:

variant in class play.api.i18n.Lang

code

public java.lang.String code()

The language tag (such as fr or en-US).

Overrides:

code in class play.api.i18n.Lang

toLocale

public java.util.Locale toLocale()

Convert to a Java Locale value.

Overrides:

toLocale in class play.api.i18n.Lang

forCode

public static Lang forCode(java.lang.String code)

Create a Lang value from a code (such as fr or en-US).

Parameters:

code - the language code

Returns:

the Lang for the code, or null of no matching lang was found.

availables

@Deprecated
public static java.util.List<Lang> availables()

Deprecated. Please use Lang.availables(app), since 2.5.0

Retrieve Lang availables from the application configuration.

Returns:

the available languages

availables

public static java.util.List<Lang> availables(Application app)

Retrieve Lang availables from the application configuration.

Parameters:

app - the current application.

Returns:

the list of available Lang.

preferred

@Deprecated
public static Lang preferred(java.util.List<Lang> langs)

Deprecated. Please use preferred(app, langs). Deprecated since 2.5.0.

Guess the preferred lang in the langs set passed as argument. The first Lang that matches an available Lang wins, otherwise returns the first Lang available in this application.

Parameters:

langs - the set of langs from which to guess the preferred

Returns:

the preferred lang.

preferred

public static Lang preferred(Application app,
                             java.util.List<Lang> langs)

Guess the preferred lang in the langs set passed as argument. The first Lang that matches an available Lang wins, otherwise returns the first Lang available in this application.

Parameters:

app - the currept application

langs - the set of langs from which to guess the preferred

Returns:

the preferred lang.