モジュール java.base

パッケージ java.text

クラスDateFormatSymbols

java.lang.Object

java.text.DateFormatSymbols

すべての実装されたインタフェース:

Serializable, Cloneable

public class DateFormatSymbols extends Object implements Serializable, Cloneable

DateFormatSymbolsは、月、曜日、タイムゾーン・データなど、ローカライズが可能な日付/時刻フォーマット・データをカプセル化するためのpublicクラスです。 SimpleDateFormatは、DateFormatSymbolsを使ってこの情報をカプセル化します。

一般には、DateFormatSymbolsを直接使うことはしません。 その代わりに、DateFormatクラスのファクトリ・メソッドgetTimeInstance、getDateInstanceまたはgetDateTimeInstanceを使って日時フォーマッタを作成することをお薦めします。 これらのメソッドを使うと、そのフォーマッタのDateFormatSymbolsが自動的に作成されるので、新しく作成する必要はありません。 フォーマッタが作成されたら、そのフォーマット・パターンはsetPatternメソッドを使って修正することができます。 DateFormatのファクトリ・メソッドを使ってフォーマットを作成する方法については、DateFormatを参照してください。

特定ロケールの特定フォーマット・パターンを使って日時フォーマッタを作成する場合には、次の方法でできます。

new SimpleDateFormat(aPattern, DateFormatSymbols.getInstance(aLocale));

ロケールに"rg" (リージョン・オーバーライド) 「Unicode拡張」が含まれている場合、指定されたリージョンのシンボルはオーバーライドされます。

DateFormatSymbolsオブジェクトは複製可能です。 DateFormatSymbolsオブジェクトを取得したら、その日時フォーマット・データを自由に変更できます。 たとえば、ローカライズされた日時フォーマット・パターン文字を、覚えやすいものに置き換えることができます。 あるいは、代表的な都市名を好みのものに変えることができます。

追加ロケールの日時フォーマットのSimpleDateFormatをサポートするために、新しいDateFormatSymbolsサブクラスを追加できます。

導入されたバージョン:

1.1

関連項目:

• DateFormat
• SimpleDateFormat
• SimpleTimeZone
• 直列化された形式

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

コンストラクタ

コンストラクタ	説明
DateFormatSymbols()	デフォルトのFORMATロケール用のリソースからフォーマット・データをロードすることによって、DateFormatSymbolsオブジェクトを構築します。
DateFormatSymbols(Locale locale)	指定されたロケールに対するリソースからフォーマット・データを読み込むことによって、DateFormatSymbolsオブジェクトを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
Object	clone()	Cloneableをオーバーライドします。
boolean	equals(Object obj)	指定されたオブジェクトをこのDateFormatSymbolsと比較し、等しいかどうかを確認します。
String[]	getAmPmStrings()	午前/午後の文字列を取得します。
static Locale[]	getAvailableLocales()	このクラスのgetInstanceメソッドがローカライズされたインスタンスを返すことのできるロケールすべての配列を返します。
String[]	getEras()	紀元の文字列を取得します。
static final DateFormatSymbols	getInstance()	デフォルト・ロケールのDateFormatSymbolsインスタンスを取得します。
static final DateFormatSymbols	getInstance(Locale locale)	指定されたロケールのDateFormatSymbolsインスタンスを取得します。
String	getLocalPatternChars()	ローカライズされた日付/時間パターン文字を取得します。
String[]	getMonths()	月の文字列を取得します。
String[]	getShortMonths()	月の短縮文字列を取得します。
String[]	getShortWeekdays()	曜日の短縮文字列を取得します。
String[]	getWeekdays()	曜日の文字列を取得します。
String[][]	getZoneStrings()	タイムゾーンの文字列を取得します。
int	hashCode()	このDateFormatSymbolsのハッシュ・コードを返します。
void	setAmPmStrings(String[] newAmpms)	午前/午後の文字列を設定します。
void	setEras(String[] newEras)	紀元の文字列を設定します。
void	setLocalPatternChars(String newLocalPatternChars)	ローカライズされた日付/時刻パターン文字を設定します。
void	setMonths(String[] newMonths)	月の文字列を設定します。
void	setShortMonths(String[] newShortMonths)	月の短縮文字列を設定します。
void	setShortWeekdays(String[] newShortWeekdays)	曜日の短縮文字列を設定します。
void	setWeekdays(String[] newWeekdays)	曜日の文字列を設定します。
void	setZoneStrings(String[][] newZoneStrings)	タイムゾーンの文字列を設定します。

クラスjava.lang.Objectで宣言されたメソッド

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

コンストラクタの詳細

DateFormatSymbols

public DateFormatSymbols()

デフォルトのFORMATロケール用のリソースからフォーマット・データをロードすることによって、DateFormatSymbolsオブジェクトを構築します。 このコンストラクタでは、Java実行環境でサポートされているロケールについてのみ、インスタンスを構築できます。インストールされているDateFormatSymbolsProvider実装でサポートされているロケールについては、インスタンスを構築できません。 すべてのロケールをカバーするには、getInstanceメソッドを使用してください。

これは、DateFormatSymbols(Locale.getDefault(Locale.Category.FORMAT))の呼び出しと同等です。

例外:

MissingResourceException - デフォルト・ロケールに対するリソースが見つからないか、読み込めない場合。

関連項目:

• getInstance()
• Locale.getDefault(java.util.Locale.Category)
• Locale.Category.FORMAT

DateFormatSymbols

public DateFormatSymbols(Locale locale)

指定されたロケールに対するリソースからフォーマット・データを読み込むことによって、DateFormatSymbolsオブジェクトを構築します。 このコンストラクタでは、Java実行環境でサポートされているロケールについてのみ、インスタンスを構築できます。インストールされているDateFormatSymbolsProvider実装でサポートされているロケールについては、インスタンスを構築できません。 すべてのロケールをカバーするには、getInstanceメソッドを使用してください。

パラメータ:

locale - 目的のロケール

例外:

MissingResourceException - 指定されたロケールに対するリソースが見つからないか、読み込めない場合。

関連項目:

• getInstance(Locale)

メソッドの詳細

getAvailableLocales

public static Locale[] getAvailableLocales()

このクラスのgetInstanceメソッドがローカライズされたインスタンスを返すことのできるロケールすべての配列を返します。 返される配列は、JavaランタイムおよびインストールされているDateFormatSymbolsProvider実装によってサポートされているロケールの和集合を表します。 少なくとも、返される配列には、Locale.ROOTに等しいLocaleインスタンスと、Locale.USに等しいLocaleインスタンスが含まれている必要があります。

戻り値:

ローカライズされたDateFormatSymbolsインスタンスを使用可能なロケールの配列。

導入されたバージョン:

1.6

getInstance

public static final DateFormatSymbols getInstance()

デフォルト・ロケールのDateFormatSymbolsインスタンスを取得します。 このメソッドを使用すると、Javaランタイム自体でサポートされているロケールと、インストールされているDateFormatSymbolsProvider実装でサポートされているロケールの、DateFormatSymbolsインスタンスにアクセスできます。

これは、getInstance(Locale.getDefault(Locale.Category.FORMAT))の呼び出しと同等です。

戻り値:

DateFormatSymbolsのインスタンス。

導入されたバージョン:

1.6

関連項目:

• Locale.getDefault(java.util.Locale.Category)
• Locale.Category.FORMAT

getInstance

public static final DateFormatSymbols getInstance(Locale locale)

指定されたロケールのDateFormatSymbolsインスタンスを取得します。 このメソッドを使用すると、Javaランタイム自体でサポートされているロケールと、インストールされているDateFormatSymbolsProvider実装でサポートされているロケールの、DateFormatSymbolsインスタンスにアクセスできます。

パラメータ:

locale - 指定されたロケール。

戻り値:

DateFormatSymbolsのインスタンス。

例外:

NullPointerException - localeがnullである場合

導入されたバージョン:

1.6

getEras

public String[] getEras()

紀元の文字列を取得します。 たとえば: 「AD」、「BC」。

戻り値:

紀元の文字列。

setEras

public void setEras(String[] newEras)

紀元の文字列を設定します。 たとえば: 「AD」、「BC」。

パラメータ:

newEras - 新しい紀元の文字列。

getMonths

public String[] getMonths()

月の文字列を取得します。 例えば: "1月"、"2月"など。Calendar.UNDECIMBERがサポートされているかどうかによって、12または13要素のいずれかの配列が返されます。 結果配列を索引付けするには、Calendar.JANUARY、Calendar.FEBRUARYなどを使用します。

フォーマットおよびスタンドアロンの使用のために異なる形式を言語が必要とする場合、このメソッドは月の名前をフォーマット形式で返します。 たとえば、チェコ語で優先する1月の月の名前は、フォーマット形式ではlednaですが、スタンドアロン形式ではledenです。 この場合、このメソッドは"ledna"を返します。 詳細は、Unicode Locale Data Markup Language (LDML)仕様のカレンダ要素を参照してください。

実装要件:

このメソッドはCalendar.UNDECIMBERがサポートされているため、13個の要素を戻します。

戻り値:

月の文字列。

外部仕様

• Unicodeロケール・データ・マークアップ言語(LDML)

setMonths

public void setMonths(String[] newMonths)

月の文字列を設定します。 たとえば: 「January」、「February」など。

パラメータ:

newMonths - 新しい月の文字列。 配列は、Calendar.JANUARY、Calendar.FEBRUARYなどで索引付けする必要があります。

getShortMonths

public String[] getShortMonths()

月の短縮文字列を取得します。 例えば: "1月"、"2月"など。Calendar.UNDECIMBERがサポートされているかどうかによって、12または13要素のいずれかの配列が返されます。 結果配列を索引付けするには、Calendar.JANUARY、Calendar.FEBRUARYなどを使用します。

書式設定とスタンドアロン使用に異なるフォームが必要な言語の場合、このメソッドは書式設定フォームで短い月の名前を返します。 たとえば、カタロニア語で優先する1月の略称は、フォーマット形式ではde gen.ですが、スタンドアロン形式ではgen.です。 この場合、このメソッドは"de gen."を返します。 詳細は、Unicode Locale Data Markup Language (LDML)仕様のカレンダ要素を参照してください。

実装要件:

このメソッドはCalendar.UNDECIMBERがサポートされているため、13個の要素を戻します。

戻り値:

月の短縮文字列。

外部仕様

• Unicodeロケール・データ・マークアップ言語(LDML)

setShortMonths

public void setShortMonths(String[] newShortMonths)

月の短縮文字列を設定します。 たとえば: 「Jan」、「Feb」など。

パラメータ:

newShortMonths - 新しい月の短縮文字列。 配列は、Calendar.JANUARY、Calendar.FEBRUARYなどで索引付けする必要があります。

getWeekdays

public String[] getWeekdays()

曜日の文字列を取得します。 たとえば: 「Sunday」、「Monday」など。

戻り値:

曜日の文字列。 Calendar.SUNDAY、Calendar.MONDAYなどを使用して、結果配列に索引付けします。

setWeekdays

public void setWeekdays(String[] newWeekdays)

曜日の文字列を設定します。 たとえば: 「Sunday」、「Monday」など。

パラメータ:

newWeekdays - 新しい曜日の文字列。 配列は、Calendar.SUNDAY、Calendar.MONDAYなどで索引付けする必要があります。

getShortWeekdays

public String[] getShortWeekdays()

曜日の短縮文字列を取得します。 たとえば: 「Sun」、「Mon」など。

戻り値:

曜日の短縮文字列。 Calendar.SUNDAY、Calendar.MONDAYなどを使用して、結果配列に索引付けします。

setShortWeekdays

public void setShortWeekdays(String[] newShortWeekdays)

曜日の短縮文字列を設定します。 たとえば: 「Sun」、「Mon」など。

パラメータ:

newShortWeekdays - 新しい曜日の短縮文字列。 配列は、Calendar.SUNDAY、Calendar.MONDAYなどで索引付けする必要があります。

getAmPmStrings

public String[] getAmPmStrings()

午前/午後の文字列を取得します。 たとえば: 「AM」、「PM」。

戻り値:

午前/午後の文字列。

setAmPmStrings

public void setAmPmStrings(String[] newAmpms)

午前/午後の文字列を設定します。 たとえば: 「AM」、「PM」。

パラメータ:

newAmpms - 新しい午前/午後の文字列。

getZoneStrings

public String[][] getZoneStrings()

タイムゾーンの文字列を取得します。 このメソッドを使用することは推奨されません。代わりに、TimeZone.getDisplayName()を使用してください。

返される値は、サイズがn×mの2次元の文字列配列で、この場合のmは5以上になります。 各n行は、単一のTimeZoneに対してローカライズされた名前を含むエントリです。 各行には次のものが含まれます(iは0からn-1の範囲内)。

• zoneStrings[i][0] - タイムゾーンID
• zoneStrings[i][1] - 標準時刻のゾーンの長い名前
• zoneStrings[i][2] - 標準時刻のゾーンの短い名前
• zoneStrings[i][3] - 夏時間のゾーンの長い名前
• zoneStrings[i][4] - 夏時間のゾーンの短い名前

ゾーンIDはローカライズされていません。TimeZoneクラスの、カスタムIDではない有効なIDのいずれかです。 ほかのエントリはすべてローカライズされた名前です。 ゾーンで夏時間が実装されていない場合、夏時間の名前は使用しないようにしてください。

このDateFormatSymbolsインスタンスに対してsetZoneStringsがすでに呼び出されていた場合は、その呼出しによって指定された文字列が返されます。 それ以外の場合、返される配列には、JavaランタイムおよびインストールされているTimeZoneNameProvider実装によって提供されている名前が格納されます。

戻り値:

タイムゾーンの文字列。

関連項目:

• setZoneStrings(String[][])

setZoneStrings

public void setZoneStrings(String[][] newZoneStrings)

タイムゾーンの文字列を設定します。 引数は、サイズがn×mの2次元の文字列配列を指定する必要があり、この場合のmは5以上になります。 各n行は、単一のTimeZoneに対してローカライズされた名前を含むエントリです。 各行には次のものが含まれます(iは0からn-1の範囲内)。

• zoneStrings[i][0] - タイムゾーンID
• zoneStrings[i][1] - 標準時刻のゾーンの長い名前
• zoneStrings[i][2] - 標準時刻のゾーンの短い名前
• zoneStrings[i][3] - 夏時間のゾーンの長い名前
• zoneStrings[i][4] - 夏時間のゾーンの短い名前

ゾーンIDはローカライズされていません。TimeZoneクラスの、カスタムIDではない有効なIDのいずれかです。 ほかのエントリはすべてローカライズされた名前です。

パラメータ:

newZoneStrings - 新しいタイムゾーン文字列。

例外:

IllegalArgumentException - newZoneStringsのいずれかの行が5より短い場合

NullPointerException - newZoneStringsがnullである場合

関連項目:

• getZoneStrings()

getLocalPatternChars

public String getLocalPatternChars()

ローカライズされた日付/時間パターン文字を取得します。 たとえば: 「u」、「t」など。

戻り値:

ローカライズされた日時パターン文字。

setLocalPatternChars

public void setLocalPatternChars(String newLocalPatternChars)

ローカライズされた日付/時刻パターン文字を設定します。 たとえば: 「u」、「t」など。

パラメータ:

newLocalPatternChars - 新しいローカライズされた日時パターン文字。

clone

public Object clone()

Cloneableをオーバーライドします。

オーバーライド:

clone、クラスObject

戻り値:

このインスタンスの複製。

関連項目:

• Cloneable

hashCode

public int hashCode()

このDateFormatSymbolsのハッシュ・コードを返します。

オーバーライド:

hashCode、クラスObject

実装要件:

このクラスの非一時インスタンス・フィールドは、Objects.hashCode(java.lang.Object)で定義された契約に準拠するハッシュ・コード値の計算に使用されます。

戻り値:

このDateFormatSymbolsのハッシュ・コード

関連項目:

• Object.hashCode()

equals

public boolean equals(Object obj)

指定されたオブジェクトをこのDateFormatSymbolsと比較し、等しいかどうかを確認します。 オブジェクトがDateFormatSymbolsでもあり、2つのDateFormatSymbolsオブジェクトが同じ日時書式データを表す場合はtrueを返します。

オーバーライド:

equals、クラスObject

実装要件:

このメソッドは、instanceofではなく、getClass()に基づくクラス・アイデンティティの概念を使用して等価チェックを実行します。 したがって、サブクラスのequalsメソッドでは、このクラスのインスタンスはサブクラスのインスタンスと等しく比較されません。

パラメータ:

obj - 等価性のために比較されるオブジェクト

戻り値:

指定されたオブジェクトがこのDateFormatSymbolsと等しい場合はtrue

関連項目:

• Object.equals(Object)