モジュール java.base
パッケージ 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を使用します。

導入されたバージョン:
1.1
関連項目:
Format

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

    コンストラクタ 
    コンストラクタ 説明
    FieldPosition​(int field)
    指定されたフィールドのためのFieldPositionオブジェクトを生成します。
    FieldPosition​(Format.Field attribute)
    指定されたフィールド定数のためのFieldPositionオブジェクトを生成します。
    FieldPosition​(Format.Field attribute, int fieldID)
    指定されたフィールドのための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で終わります。
      パラメータ:
      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のサブクラスが使用します。
      パラメータ:
      bi - 開始インデックス
      導入されたバージョン:
      1.2

    • setEndIndex

      public void setEndIndex​(int ei)
      終了インデックスを設定します。 Formatのサブクラスが使用します。
      パラメータ:
      ei - 終了インデックス
      導入されたバージョン:
      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
      戻り値:
      このオブジェクトの文字列表現