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

Field Summary

Fields

Modifier and Type	Field and Description
play.api.i18n.Lang	underlyingLang

Constructor Summary

Constructors

Constructor and Description
Lang(play.api.i18n.Lang underlyingLang)

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 Lang code (such as fr or en-US).
java.lang.String	country() A valid ISO Country Code.
boolean	equals(java.lang.Object other)
static Lang	forCode(java.lang.String code) Create a Lang value from a code (such as fr or en-US).
int	hashCode()
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.util.Locale	toLocale() Convert to a Java Locale value.

Methods inherited from class play.api.i18n.Lang

$lessinit$greater$default$2, apply, apply, apply$default$2, canEqual, copy, copy$default$1, copy$default$2, defaultLang, get, preferred, productArity, productElement, productIterator, productPrefix, satisfies, toString, unapply

Methods inherited from class java.lang.Object

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

Field Detail

underlyingLang

public final play.api.i18n.Lang underlyingLang

Constructor Detail

Lang

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

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

code

public java.lang.String code()

The Lang code (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

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface scala.Equals

Overrides:

equals in class play.api.i18n.Lang

hashCode

public int hashCode()

Overrides:

hashCode 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.

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:

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

Returns:

the preferred lang.