jinro
クラス JinroLocalization

java.lang.Object
  jinro.JinroLocalization

public class JinroLocalization
extends Object

ローカライズ処理のためのクラス。 指定されたLocale及び該当する言語データを基にローカライズされた文字列のバンドルやファイルを用意します。 文字列のバンドル（JinroLocalizationオブジェクト）を作成（取得）するには、staticメソッドのgetBundleを使用します。

JinroLocalization.getBundle(String name)

引数のファイルパスには言語データが記述されたpropertiesファイルを指定します。パスは各言語のディレクトリを基準とした相対パスで記述して下さい。そうすることでロケールに合わせたディレクトリにあるファイルを取得することが出来ます。

導入されたバージョン:

Jinro! Second Edition Ver.0.20

メソッドの概要

JinroLocalization	attachBundle(JinroLocalization bundle) 現在のインスタンスに別の言語データを追加した新たなインスタンスを生成します。
JinroLocalization	attachBundle(String name) 現在のインスタンスに別の言語データを追加した新たなインスタンスを生成します。
Locale	getActualLocale() 使用されているロケールを返します。
String	getActualLocaleString() 使用されているロケールの文字列表現を返します。
static JinroLocalization	getBundle(String name) JinroLocalizationのインスタンスを取得します。
static File	getFile(String name) 言語データフォルダ内のファイルを取得します。
static Locale	getLocale() 現在設定されているロケールを返します。
static String	getLocaleString() 現在のロケールの文字列表現を返します。
String	getString(String key, Object... parameters) キーと付加パラメータを基にローカライズされた文字列を返します。
static boolean	isLocaleDefault() 設定されているロケールが初期状態のままであるかを取得します。
static void	setLocale() デフォルトのロケールに設定します。
static void	setLocale(Locale newLocale) 指定のロケールに設定します。
static void	setLocale(String localeString) 指定のロケールに設定します。

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

setLocale

public static void setLocale()

デフォルトのロケールに設定します。

setLocale

public static void setLocale(Locale newLocale)

指定のロケールに設定します。

パラメータ:

newLocale - 設定するロケール

setLocale

public static void setLocale(String localeString)

指定のロケールに設定します。

パラメータ:

localeString - 設定するロケールの文字列表現

getLocale

public static Locale getLocale()

現在設定されているロケールを返します。 実際に使用されている言語とは必ずしも一致しません。

戻り値:

現在のロケール

getLocaleString

public static String getLocaleString()

現在のロケールの文字列表現を返します。 実際に使用されている言語とは必ずしも一致しません。

戻り値:

現在のロケールの文字列表現

isLocaleDefault

public static boolean isLocaleDefault()

設定されているロケールが初期状態のままであるかを取得します。

戻り値:

初期状態ならtrue、そうでなければfalse

getFile

public static File getFile(String name)

言語データフォルダ内のファイルを取得します。 ファイルは設定されているロケールに一致する、あるいは最も近いものが返され、それが無い場合は米国英語のロケールに一致する、あるいは最も近いものが返されます。 それでも見つからない場合は任意のロケールにあるものが返されます。 ロケールとの一致度合いが等しいファイルがスクリプトの言語データフォルダと本体の言語データフォルダ両方にある場合は、前者のファイルが優先されます。

パラメータ:

name - 対象のファイル名

戻り値:

言語データフォルダ内の指定ファイル

getBundle

public static JinroLocalization getBundle(String name)

JinroLocalizationのインスタンスを取得します。 言語データを取得するときは設定されているロケールと一致する度合いが高いものから優先して検索され、 以下、米国英語のロケールと一致する度合いの高い順、そして任意のロケールにある言語データファイルの順で行われていきます。 また、上記優先順位の等しいファイルがスクリプトの言語データフォルダと本体の言語データフォルダ両方にある場合は、前者のファイルが優先されます。

パラメータ:

name - 対象のファイル名

戻り値:

指定のファイルで初期化した言語バンドルのインスタンス

attachBundle

public JinroLocalization attachBundle(String name)

現在のインスタンスに別の言語データを追加した新たなインスタンスを生成します。元のインスタンスは変更しません。

パラメータ:

name - 追加する言語データファイル名

戻り値:

言語データを追加した新たなJinroLocalizationインスタンス

attachBundle

public JinroLocalization attachBundle(JinroLocalization bundle)

現在のインスタンスに別の言語データを追加した新たなインスタンスを生成します。元のインスタンスは変更しません。

パラメータ:

bundle - 追加する言語データを持つJinroLocalizationインスタンス

戻り値:

言語データを追加した新たなJinroLocalizationインスタンス

getActualLocale

public Locale getActualLocale()

使用されているロケールを返します。 これはインスタンスが保持する言語データのうち最も優先度の高いもののロケールになります。

戻り値:

使用されているロケール

getActualLocaleString

public String getActualLocaleString()

使用されているロケールの文字列表現を返します。 これはインスタンスが保持する言語データのうち最も優先度の高いもののロケールになります。

戻り値:

実際に使用されているロケールの文字列表現

getString

public String getString(String key,
                        Object... parameters)

キーと付加パラメータを基にローカライズされた文字列を返します。 言語データファイルで%Sや%n$S（nは1以上の任意の数字）と書かれている部分がパラメータに置換されます。

パラメータ:

key - 文字列を抽出するためのキー

parameters - ローカライズ済み文字列に埋め込むオブジェクト

戻り値:

ローカライズされた文字列。存在しない場合はkey