java.util

Class Locale

java.lang.Object

java.util.Locale

All Implemented Interfaces:

Cloneable

public final class Locale
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
Locale(String lang, String ctry) Construct a locale from language and country.
Locale(String lang, String ctry, String var) Construct a locale from language, country and variant.

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a new object of the same class as this object.
boolean	equals(Object obj) Compares two Objects for equality.
String	getCountry()
static Locale	getDefault()
String	getDisplayCountry()
String	getDisplayCountry(Locale locale)
String	getDisplayLanguage()
String	getDisplayLanguage(Locale locale)
String	getDisplayName()
String	getDisplayName(Locale locale) Returns string formatted to describe the Locale.
String	getDisplayVariant()
String	getDisplayVariant(Locale locale)
String	getLanguage() Returns the language code of this Locale.
String	getVariant() Returns the variant code for this locale.
int	hashCode() Returns a hash code value for the object.
static void	setDefault(Locale locale) Sets the default locale for this instance of the Java Virtual Machine.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Locale

public Locale(String lang,
              String ctry)

Construct a locale from language and country.

Parameters:

lang - language code

ctry - country code

Locale

public Locale(String lang,
              String ctry,
              String var)

Construct a locale from language, country and variant.

Parameters:

lang - language code

ctry - country code

var - variation

Method Detail

clone

public Object clone()

Description copied from class: Object

Creates a new object of the same class as this object. It then initializes each of the new object's fields by assigning it the same value as the corresponding field in this object. No constructor is called.

The clone method of class Object will only clone an object whose class indicates that it is willing for its instances to be cloned. A class indicates that its instances can be cloned by declaring that it implements the Cloneable interface.

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

Cloneable

equals

public boolean equals(Object obj)

Description copied from class: Object

Compares two Objects for equality.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false.
• For any reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

getCountry

public String getCountry()

getDefault

public static Locale getDefault()

getDisplayCountry

public final String getDisplayCountry()

getDisplayCountry

public String getDisplayCountry(Locale locale)

getDisplayLanguage

public final String getDisplayLanguage()

getDisplayLanguage

public String getDisplayLanguage(Locale locale)

getDisplayName

public final String getDisplayName()

getDisplayName

public String getDisplayName(Locale locale)

Returns string formatted to describe the Locale.

Parameters:

locale - Locale

Returns:

string description

getDisplayVariant

public final String getDisplayVariant()

getDisplayVariant

public String getDisplayVariant(Locale locale)

getLanguage

public String getLanguage()

Returns the language code of this Locale.

Returns:

The language code, or the empty string if none is defined.

getVariant

public String getVariant()

Returns the variant code for this locale.

Returns:

The variant code, or the empty string if none is defined.

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

setDefault

public static void setDefault(Locale locale)

Sets the default locale for this instance of the Java Virtual Machine.

Parameters:

locale - the new default locale

toString

public final String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object.