java.text

クラス FieldPosition

java.lang.Object

java.text.FieldPosition

public class FieldPosition
extends Object

FieldPosition クラスは、フォーマットされた出力のフィールドを識別するために Format とそのサブクラスが使用する単純なクラスです。フィールドは 2 つの方法で識別されます。

• 整数型定数。名前は通常 _FIELD で終わります。定数は Format のさまざまなサブクラスで定義されます。
• Format.Field 定数。使用例は、DateFormat の ERA_FIELD などを参照してください。

FieldPosition は、フォーマットされた出力の中で、フィールドの最初の文字のインデックスとフィールドの最後の文字のインデックスの 2 つを使用してフィールドの位置を追跡します。

さまざまな Format クラスにおける format メソッドの 1 つのバージョンは、引数として FieldPosition オブジェクトを要求します。この format メソッドを使用して、部分的なフォーマットを実行したり、フォーマットされた出力 (フィールドのポジションなど) についての情報を取得できます。

フォーマットされた文字列におけるすべての属性の位置を知るには、Format メソッドの formatToCharacterIterator を使用します。

関連項目:

Format

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

コンストラクタ

コンストラクタと説明
FieldPosition(Format.Field attribute) 指定されたフィールド定数のための FieldPosition オブジェクトを生成します。
FieldPosition(Format.Field attribute, int fieldID) 指定されたフィールドのための FieldPosition オブジェクトを生成します。
FieldPosition(int field) 指定されたフィールドのための FieldPosition オブジェクトを生成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	equals(Object obj) equals をオーバーライドします。
int	getBeginIndex() 要求されたフィールドで最初の文字のインデックスを取得します。
int	getEndIndex() 要求されたフィールドで最後の文字に続く文字のインデックスを取得します。
int	getField() フィールド識別子を取得します。
Format.Field	getFieldAttribute() Field のサブクラスの 1 つからの属性定数としてフィールド識別子を返します。
int	hashCode() この FieldPosition のハッシュコードを返します。
void	setBeginIndex(int bi) 開始インデックスを設定します。
void	setEndIndex(int ei) 終了インデックスを設定します。
String	toString() この FieldPosition の文字列表現を返します。

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

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

コンストラクタの詳細

FieldPosition

public FieldPosition(int field)

指定されたフィールドのための FieldPosition オブジェクトを生成します。フィールドは、Format のさまざまなサブクラスでの定数で識別されます。定数の名前は通常、_FIELD で終わります。

関連項目:

NumberFormat.INTEGER_FIELD, NumberFormat.FRACTION_FIELD, DateFormat.YEAR_FIELD, DateFormat.MONTH_FIELD

FieldPosition

public FieldPosition(Format.Field attribute)

指定されたフィールド定数のための FieldPosition オブジェクトを生成します。フィールドは、さまざまな Format サブクラスで定義される定数で識別されます。これは、new FieldPosition(attribute, -1) の呼び出しと同等です。

パラメータ:

attribute - フィールドを識別する Format.Field 定数

導入されたバージョン:

1.4

FieldPosition

public FieldPosition(Format.Field attribute,
             int fieldID)

指定されたフィールドのための FieldPosition オブジェクトを生成します。フィールドは、Field サブクラスの 1 つからの属性定数や、Format サブクラスで定義される整数型フィールド ID によって識別されます。Field を認識する Format サブクラスは、attribute が null でない場合に attribute を優先し、fieldID を無視します。ただし、古い Format サブクラスでは Field を認識せず、fieldID に依存する場合があります。フィールドが対応する整数型定数を持たない場合は、fieldID は -1 になります。

パラメータ:

attribute - フィールドを識別する Format.Field 定数

fieldID - フィールドを識別する整数型定数

導入されたバージョン:

1.4

メソッドの詳細

getFieldAttribute

public Format.Field getFieldAttribute()

Field のサブクラスの 1 つからの属性定数としてフィールド識別子を返します。フィールドが整数型フィールド ID だけによって指定される場合は、null を返します。

戻り値:

フィールドの識別子

導入されたバージョン:

1.4

getField

public int getField()

フィールド識別子を取得します。

getBeginIndex

public int getBeginIndex()

要求されたフィールドで最初の文字のインデックスを取得します。

getEndIndex

public int getEndIndex()

要求されたフィールドで最後の文字に続く文字のインデックスを取得します。

setBeginIndex

public void setBeginIndex(int bi)

開始インデックスを設定します。Format のサブクラスが使用します。

導入されたバージョン:

1.2

setEndIndex

public void setEndIndex(int ei)

終了インデックスを設定します。Format のサブクラスが使用します。

導入されたバージョン:

1.2

equals

public boolean equals(Object obj)

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

オーバーライド:

equals、クラス: Object

パラメータ:

obj - 比較対象の参照オブジェクト。

戻り値:

このオブジェクトが obj 引数と同じである場合は true、それ以外の場合は false。

関連項目:

Object.hashCode()、HashMap

hashCode

public int hashCode()

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

オーバーライド:

hashCode、クラス: Object

戻り値:

このオブジェクトのハッシュコード値

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

この FieldPosition の文字列表現を返します。

オーバーライド:

toString、クラス: Object

戻り値:

このオブジェクトの文字列表現