Locale.Builder (Java Platform SE 7)

java.lang.Object
- java.util.Locale.Builder

含まれているクラス:

Locale
```
public static final class Locale.Builder
extends Object
```
Builder は、setter によって構成される値から Locale のインスタンスを構築するために使用されます。Locale コンストラクタとは異なり、Builder は、setter によって構成される値が Locale クラスで定義されている構文要件を満たしているかどうかを確認します。Builder によって作成される Locale オブジェクトは整形式であり、情報を失うことなく整形式の IETF BCP 47 言語タグに変換できます。
注: Locale クラスではバリアントに構文上の制限は規定されていませんが、BCP 47 では、各バリアントサブタグは 5 つから 8 つまでの英数字であるか、1 つの数字に 3 つの英数字が続いたものでなければいけません。バリアントがこの制限を満たしていない場合、setVariant は IllformedLocaleException をスローします。そのようなバリアントをサポートする必要がある場合は、Locale コンストラクタを使用してください。ただし、この方法で作成された Locale オブジェクトは、BCP 47 言語タグに変換されるときにバリアント情報を失う可能性があることに注意してください。
次の例は、Locale オブジェクトを Builder で作成する方法を示しています。
```
     Locale aLocale = new Builder().setLanguage("sr").setScript("Latn").setRegion("RS").build();
 
```
Builder は再利用できます。clear() は、すべてのフィールドをデフォルト値にリセットします。
導入されたバージョン:

1.7

関連項目:
Locale.forLanguageTag(java.lang.String)

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

Locale.Builder()
空の Builder を構築します。

コンストラクタ
コンストラクタと説明
`Locale.Builder()` 空の Builder を構築します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`Locale.Builder`	`addUnicodeLocaleAttribute(String attribute)` Unicode ロケール属性が存在しない場合にそれを追加します。それ以外の場合は何の影響もありません。
`Locale`	`build()` このビルダーに設定されているフィールドから作成された `Locale` のインスタンスを返します。
`Locale.Builder`	`clear()` ビルダーを初期の空の状態にリセットします。
`Locale.Builder`	`clearExtensions()` 拡張を初期の空の状態にリセットします。
`Locale.Builder`	`removeUnicodeLocaleAttribute(String attribute)` Unicode ロケール属性が存在する場合にそれを削除します。それ以外の場合は何の影響もありません。
`Locale.Builder`	`setExtension(char key, String value)` 指定されたキーの拡張を設定します。
`Locale.Builder`	`setLanguage(String language)` 言語を設定します。
`Locale.Builder`	`setLanguageTag(String languageTag)` Builder を指定された IETF BCP 47 言語タグに適合するようにリセットします。
`Locale.Builder`	`setLocale(Locale locale)` `Builder` を指定された `locale` に適合するようにリセットします。
`Locale.Builder`	`setRegion(String region)` 地域を設定します。
`Locale.Builder`	`setScript(String script)` スクリプトを設定します。
`Locale.Builder`	`setUnicodeLocaleKeyword(String key, String type)` 指定されたキーの Unicode ロケールキーワードの型を設定します。
`Locale.Builder`	`setVariant(String variant)` バリアントを設定します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - Locale.Builder
```
public Locale.Builder()
```
    空の Builder を構築します。すべてのフィールド、拡張、および私用情報のデフォルト値は、空の文字列です。
- メソッドの詳細
  - setLocale
```
public Locale.Builder setLocale(Locale locale)
```
    Builder を指定された locale に適合するようにリセットします。既存の状態は破棄されます。
    ロケールのフィールドはすべて整形式でなければいけません。Locale を参照してください。
    ロケールに整形式でないフィールドが含まれていると、互換性のために許容されている次の 3 つの場合を除き、IllformedLocaleException がスローされます。
    - Locale("ja", "JP", "JP") は「ja-JP-u-ca-japanese」として扱われます
    - Locale("th", "TH", "TH") は「th-TH-u-nu-thai」として扱われます
    - Locale("no", "NO", "NY") は「nn-NO」として扱われます
    パラメータ:
    locale - ロケール
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - locale に整形式でないフィールドがある場合。
    
    NullPointerException - locale が null である場合。
  - setLanguageTag
```
public Locale.Builder setLanguageTag(String languageTag)
```
    Builder を指定された IETF BCP 47 言語タグに適合するようにリセットします。既存の状態を破棄します。null および空の文字列を指定すると、clear() と同様に Builder がリセットされます。適用外のタグ (Locale.forLanguageTag(java.lang.String) を参照) は、その正規の形式に変換されてから処理されます。それ以外の場合、言語タグは整形式でなければならず (Locale を参照)、そうでない場合は例外がスローされます (タグの整形式でない部分以降を単に破棄する Locale.forLanguageTag とは異なります)。
    
    パラメータ:
    languageTag - 言語タグ
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - languageTag が整形式でない場合
    関連項目:
    Locale.forLanguageTag(String)
  - setLanguage
```
public Locale.Builder setLanguage(String language)
```
    言語を設定します。language が空の文字列または null の場合は、この Builder の言語が削除されます。それ以外の場合、言語は整形式でなければならず、そうでない場合は例外がスローされます。
    通常、言語の値は、ISO639 で定義されている 2 文字または 3 文字の言語コードです。
    
    パラメータ:
    language - 言語
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - language が整形式でない場合
  - setScript
```
public Locale.Builder setScript(String script)
```
    スクリプトを設定します。script が null または空の文字列の場合は、この Builder のスクリプトが削除されます。それ以外の場合、スクリプトは整形式でなければならず、そうでない場合は例外がスローされます。
    通常、スクリプトの値は、ISO 15924 で定義されている 4 文字のスクリプトコードです。
    
    パラメータ:
    script - スクリプト
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - script が整形式でない場合
  - setRegion
```
public Locale.Builder setRegion(String region)
```
    地域を設定します。region が null または空の文字列の場合は、この Builder の地域が削除されます。それ以外の場合、地域は整形式でなければならず、そうでない場合は例外がスローされます。
    通常、地域の値は、2 文字の ISO 3166 コードか、3 桁の UN M.49 地域コードです。
    Builder によって作成される Locale の国の値は、常に大文字に正規化されます。
    
    パラメータ:
    region - 地域
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - region が整形式でない場合
  - setVariant
```
public Locale.Builder setVariant(String variant)
```
    バリアントを設定します。variant が null または空の文字列の場合は、この Builder のバリアントが削除されます。それ以外の場合、1 つ以上の整形式サブタグから成る必要があり、そうでない場合は例外がスローされます。
    注: このメソッドは、variant が IETF BCP 47 のバリアントサブタグの構文要件を満たしているかどうかを確認し、値を小文字に正規化します。ただし、Locale クラスではバリアントに構文上の制限は規定されず、Locale のバリアント値では大文字と小文字が区別されます。そのようなバリアントを設定するには、Locale コンストラクタを使用してください。
    
    パラメータ:
    variant - バリアント
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - variant が整形式でない場合
  - setExtension
```
public Locale.Builder setExtension(char key,
                          String value)
```
    指定されたキーの拡張を設定します。value が null または空の文字列の場合は、拡張が削除されます。それ以外の場合、拡張は整形式でなければならず、そうでない場合は例外がスローされます。
    注: キー UNICODE_LOCALE_EXTENSION (「u」) は Unicode ロケール拡張に使用されます。このキーの値を設定すると、Unicode ロケールキーとタイプの既存のペアがすべて、この拡張で定義されたものに置き換えられます。
    注: キー PRIVATE_USE_EXTENSION (「x」) は私用コードに使用されます。整形式となるためには、このキーの値は、一般的な 2 文字から 8 文字までではなく、1 文字から 8 文字までの英数字のサブタグだけを含む必要があります。
    
    パラメータ:
    key - 拡張キー
    value - 拡張値
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - key が不正であるか value が整形式でない場合
    関連項目:
    setUnicodeLocaleKeyword(String, String)
  - setUnicodeLocaleKeyword
```
public Locale.Builder setUnicodeLocaleKeyword(String key,
                                     String type)
```
    指定されたキーの Unicode ロケールキーワードの型を設定します。type が null の場合は、Unicode キーワードが削除されます。それ以外の場合、キーは null 以外で、キーとタイプの両方が整形式でなければならず、そうでない場合は例外がスローされます。
    キーとタイプは小文字に変換されます。
    注: setExtension(char, java.lang.String) を使用して「u」拡張を設定すると、すべての Unicode ロケールキーワードが、この拡張で定義されたものに置き換えられます。
    
    パラメータ:
    key - Unicode ロケールキー
    type - Unicode ロケールタイプ
    
    戻り値:
    このビルダー。
    
    例外:
    
    IllformedLocaleException - key または type が整形式でない場合
    
    NullPointerException - key が null である場合
    関連項目:
    setExtension(char, String)
  - addUnicodeLocaleAttribute
```
public Locale.Builder addUnicodeLocaleAttribute(String attribute)
```
    Unicode ロケール属性が存在しない場合にそれを追加します。それ以外の場合は何の影響もありません。この属性は null であってはならず、整形式である必要があります。そうでない場合は例外がスローされます。
    
    パラメータ:
    attribute - 属性
    
    戻り値:
    このビルダー。
    
    例外:
    
    NullPointerException - attribute が null である場合
    
    IllformedLocaleException - attribute が整形式でない場合
    関連項目:
    setExtension(char, String)
  - removeUnicodeLocaleAttribute
```
public Locale.Builder removeUnicodeLocaleAttribute(String attribute)
```
    Unicode ロケール属性が存在する場合にそれを削除します。それ以外の場合は何の影響もありません。この属性は null であってはならず、整形式である必要があります。そうでない場合は例外がスローされます。
    削除のための属性の比較では、大文字と小文字は区別されません。
    
    パラメータ:
    attribute - 属性
    
    戻り値:
    このビルダー。
    
    例外:
    
    NullPointerException - attribute が null である場合
    
    IllformedLocaleException - attribute が整形式でない場合
    関連項目:
    setExtension(char, String)
  - clear
```
public Locale.Builder clear()
```
    ビルダーを初期の空の状態にリセットします。
    
    戻り値:
    このビルダー。
  - clearExtensions
```
public Locale.Builder clearExtensions()
```
    拡張を初期の空の状態にリセットします。言語、スクリプト、地域、およびバリアントは変更されません。
    
    戻り値:
    このビルダー。
    関連項目:
    setExtension(char, String)
  - build
```
public Locale build()
```
    このビルダーに設定されているフィールドから作成された Locale のインスタンスを返します。
    Locale の構築時に、Locale.forLanguageTag(java.lang.String) に示された変換が適用されます。(適用外のタグは setLanguageTag(java.lang.String) で処理されます。)
    
    戻り値:
    Locale。

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス Locale.Builder

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

コンストラクタの詳細

Locale.Builder

メソッドの詳細

setLocale

setLanguageTag

setLanguage

setScript

setRegion

setVariant

setExtension

setUnicodeLocaleKeyword

addUnicodeLocaleAttribute

removeUnicodeLocaleAttribute

clear

clearExtensions

build