LocaleUtil (org.tinygroup.commons 3.4.9 API)

java.lang.Object
- org.tinygroup.commons.i18n.LocaleUtil

```
public class LocaleUtil
extends Object
```
用来处理地域和字符编码的工具类。
由于系统locale和charset是不可靠的，不同的环境可能会有不同的系统设置，因此应用程序最好不要依赖这个系统值。 LocaleUtil提供了一个方案，可以“修改”默认locale和charset。

LocaleUtil提供了以下几个作用域的locale/charset设定：
- 系统作用域：由JVM所运行的操作系统环境决定，在JVM生命期内不改变。可通过LocaleUtil.getSystem() 取得。
- 默认作用域：在整个JVM中全局有效，可被改变。可通过LocaleUtil.getDefault() 取得。如未明确指定，则取“系统作用域”的值。
- 线程作用域：在整个线程中全局有效，可被改变。可通过LocaleUtil.getContext() 取得。如未明确指定，则取“默认作用域”的值。每个线程都可以有自己的locale和charset设置，不会干扰其它线程。
Util工具箱里的其它工具类，当需要时，将从LocaleUtil.getContext() 中取得当前的locale和charset设置。例如：StringEscapeUtil.escapeURL(value) ，如不指定charset ，将从context中取得charset。这样，框架往往可以修改context值，而所有线程中的方法调用将服从于框架的locale和charset设定。
作者:

Michael Zhou

嵌套类概要

嵌套类
限定符和类型类和说明

static interface LocaleUtil.Notifier
当default或context locale被改变时，通知监听器。

嵌套类
限定符和类型	类和说明
`static interface`	`LocaleUtil.Notifier` 当default或context locale被改变时，通知监听器。

构造器概要

构造器
构造器和说明

LocaleUtil()

构造器
构造器和说明
`LocaleUtil()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static List<String>`	`calculateBundleNames(String baseName, Locale locale)` 取得备选的resource bundle风格的名称列表。
`static List<String>`	`calculateBundleNames(String baseName, Locale locale, boolean noext)` 取得备选的resource bundle风格的名称列表。
`static String`	`getCanonicalCharset(String charset)` 取得正规的字符集名称, 如果指定字符集不存在, 则抛出`UnsupportedEncodingException`.
`static LocaleInfo`	`getContext()` 取得当前thread默认的区域。
`static LocaleInfo`	`getDefault()` 取得默认的区域。
`static LocaleInfo`	`getSystem()` 取得操作系统默认的区域。
`static boolean`	`isCharsetSupported(String charset)` 判断指定的charset是否被支持。
`static boolean`	`isLocaleSupported(Locale locale)` 判断locale是否被支持。
`static Locale`	`parseLocale(String localeString)` 解析locale字符串。
`static void`	`resetContext()` 复位当前thread的区域设置。
`static void`	`resetDefault()` 复位默认的区域设置。
`static LocaleInfo`	`setContext(Locale locale)` 设置当前thread默认的区域。
`static LocaleInfo`	`setContext(LocaleInfo localeInfo)` 设置当前thread默认的区域。
`static LocaleInfo`	`setContext(Locale locale, String charset)` 设置当前thread默认的区域。
`static LocaleInfo`	`setDefault(Locale locale)` 设置默认的区域。
`static LocaleInfo`	`setDefault(LocaleInfo localeInfo)` 设置默认的区域。
`static LocaleInfo`	`setDefault(Locale locale, String charset)` 设置默认的区域。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - LocaleUtil
```
public LocaleUtil()
```
- 方法详细资料
  - isLocaleSupported
```
public static boolean isLocaleSupported(Locale locale)
```
    判断locale是否被支持。
    
    参数:
    
    locale - 要检查的locale
  - isCharsetSupported
```
public static boolean isCharsetSupported(String charset)
```
    判断指定的charset是否被支持。
    
    参数:
    
    charset - 要检查的charset
  - parseLocale
```
public static Locale parseLocale(String localeString)
```
    解析locale字符串。
    Locale字符串是符合下列格式：language_country_variant。
    
    参数:
    
    localeString - 要解析的字符串
    
    返回:
    
    Locale对象，如果locale字符串为空，则返回null
  - getCanonicalCharset
```
public static String getCanonicalCharset(String charset)
```
    取得正规的字符集名称, 如果指定字符集不存在, 则抛出UnsupportedEncodingException.
    
    参数:
    
    charset - 字符集名称
    
    返回:
    
    正规的字符集名称
    
    抛出:
    
    IllegalCharsetNameException - 如果指定字符集名称非法
    
    UnsupportedCharsetException - 如果指定字符集不存在
  - calculateBundleNames
```
public static List<String> calculateBundleNames(String baseName,
                                                Locale locale)
```
    取得备选的resource bundle风格的名称列表。
    例如： calculateBundleNames("hello.jsp", new Locale("zh", "CN", "variant")) 将返回下面列表：
    1. hello_zh_CN_variant.jsp
    2. hello_zh_CN.jsp
    3. hello_zh.jsp
    4. hello.jsp
    参数:
    
    baseName - bundle的基本名
    
    locale - 区域设置
    
    返回:
    
    所有备选的bundle名
  - calculateBundleNames
```
public static List<String> calculateBundleNames(String baseName,
                                                Locale locale,
                                                boolean noext)
```
    取得备选的resource bundle风格的名称列表。
    例如： calculateBundleNames("hello.jsp", new Locale("zh", "CN", "variant"), false)将返回下面列表：
    1. hello_zh_CN_variant.jsp
    2. hello_zh_CN.jsp
    3. hello_zh.jsp
    4. hello.jsp
    当noext为true时，不计算后缀名，例如 calculateBundleNames("hello.world", new Locale("zh", "CN", "variant"), true)将返回下面列表：
    1. hello.world_zh_CN_variant
    2. hello.world_zh_CN
    3. hello.world_zh
    4. hello.world
    参数:
    
    baseName - bundle的基本名
    
    locale - 区域设置
    
    返回:
    
    所有备选的bundle名
  - getSystem
```
public static LocaleInfo getSystem()
```
    取得操作系统默认的区域。
    
    返回:
    
    操作系统默认的区域
  - getDefault
```
public static LocaleInfo getDefault()
```
    取得默认的区域。
    
    返回:
    
    默认的区域
  - setDefault
```
public static LocaleInfo setDefault(Locale locale)
```
    设置默认的区域。
    
    参数:
    
    locale - 区域
    
    返回:
    
    原来的默认区域
  - setDefault
```
public static LocaleInfo setDefault(Locale locale,
                                    String charset)
                             throws UnsupportedCharsetException
```
    设置默认的区域。
    
    参数:
    
    locale - 区域
    
    charset - 编码字符集
    
    返回:
    
    原来的默认区域
    
    抛出:
    
    UnsupportedCharsetException
  - setDefault
```
public static LocaleInfo setDefault(LocaleInfo localeInfo)
                             throws UnsupportedCharsetException
```
    设置默认的区域。
    
    参数:
    
    localeInfo - 区域和编码字符集信息
    
    返回:
    
    原来的默认区域
    
    抛出:
    
    UnsupportedCharsetException
  - resetDefault
```
public static void resetDefault()
```
    复位默认的区域设置。
  - getContext
```
public static LocaleInfo getContext()
```
    取得当前thread默认的区域。
    
    返回:
    
    当前thread默认的区域
  - setContext
```
public static LocaleInfo setContext(Locale locale)
```
    设置当前thread默认的区域。
    
    参数:
    
    locale - 区域
    
    返回:
    
    原来的thread默认的区域
  - setContext
```
public static LocaleInfo setContext(Locale locale,
                                    String charset)
                             throws UnsupportedCharsetException
```
    设置当前thread默认的区域。
    
    参数:
    
    locale - 区域
    
    charset - 编码字符集
    
    返回:
    
    原来的thread默认的区域
    
    抛出:
    
    UnsupportedCharsetException
  - setContext
```
public static LocaleInfo setContext(LocaleInfo localeInfo)
                             throws UnsupportedCharsetException
```
    设置当前thread默认的区域。
    
    参数:
    
    localeInfo - 区域和编码字符集信息
    
    返回:
    
    原来的thread默认的区域
    
    抛出:
    
    UnsupportedCharsetException
  - resetContext
```
public static void resetContext()
```
    复位当前thread的区域设置。

类 LocaleUtil

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

LocaleUtil

方法详细资料

isLocaleSupported

isCharsetSupported

parseLocale

getCanonicalCharset

calculateBundleNames

calculateBundleNames

getSystem

getDefault

setDefault

setDefault

setDefault

resetDefault

getContext

setContext

setContext

setContext

resetContext