インターフェース LoopTagStatus
public interface LoopTagStatus
反復の現在のステータスを公開します。Jakarta Standard Tag Library は、LoopTags が反復の現在のインデックスに関する情報を返すメカニズムと、現在のラウンドが反復の最初か最後かを判断する便利なメソッドを提供します。また、作成者はステータスオブジェクトを使用して、反復範囲、ステップ、現在のオブジェクトに関する情報を取得できます。
より多くのステータスが必要な環境では、このインターフェースを継承できます。
- 作成者:
- Shawn Bayern
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 IntegerSE
getBegin()
関連するタグの 'begin' 属性の値を返します。'begin' 属性が指定されていない場合は null を返します。int
getCount()
反復の現在のラウンドの「カウント」を取得します。ObjectSE
getCurrent()
イテレーションの現在のアイテムを取得します。IntegerSE
getEnd()
関連するタグの 'end' 属性の値を返します。'end' 属性が指定されていない場合は null を返します。int
getIndex()
反復の現在のラウンドのインデックスを取得します。IntegerSE
getStep()
関連するタグの 'step' 属性の値を返します。'step' 属性が指定されていない場合は null を返します。boolean
isFirst()
反復の現在のラウンドが最初のラウンドかどうかに関する情報を返します。boolean
isLast()
反復の現在のラウンドが最後のラウンドであるかどうかに関する情報を返します。
メソッドの詳細
getCurrent
ObjectSE getCurrent()
イテレーションの現在のアイテムを取得します。べき等に振る舞う。getCurrent() を繰り返し呼び出すと、反復が進むまで同じオブジェクトが返されます。(具体的には、getCurrent() を呼び出しても反復 は進みません )- 戻り値:
- オブジェクトとしての現在のアイテム
getIndex
int getIndex()
反復の現在のラウンドのインデックスを取得します。基礎となる配列、java.lang.Collection、その他の型のサブセットに対して反復が実行されている場合、返されるインデックスは、基礎となるコレクションに対して絶対です。インデックスは 0 ベースです。- 戻り値:
- 反復の現在のラウンドの 0 ベースのインデックス
getCount
int getCount()
反復の現在のラウンドの「カウント」を取得します。カウントは、反復の現在の「ラウンド」を識別する相対的な 1 ベースのシーケンス番号です(現在の反復が実行するすべてのラウンドのコンテキストで)。
例として、begin = 5、end = 15、step = 5 の反復では、カウント 1, 2、3 がこの順序で生成されます。
- 戻り値:
- 反復の現在のラウンドの 1 ベースのカウント
isFirst
boolean isFirst()
反復の現在のラウンドが最初のラウンドかどうかに関する情報を返します。この現在のラウンドは、getIndex()!= 0 の場合でも「最初」になる可能性があります。「インデックス」は、基礎となるコレクションのコンテキストでの現在の「アイテム」の絶対インデックスを参照するためです。isFirst() からの真の結果が getCount() == 1 を暗示するのは常にその場合です。- 戻り値:
- 現在のラウンドが反復の最初のラウンドである場合は
true
、それ以外の場合はfalse
。
isLast
boolean isLast()
反復の現在のラウンドが最後のラウンドであるかどうかに関する情報を返します。isFirst() と同様に、サブセット化が考慮されます。isLast() は、必ずしも基礎となるイテレーターのステータスを参照する必要はありません。現在のラウンドが、この LoopTagStatus に関連付けられたタグの反復の最終ラウンドになるかどうかを示します。- 戻り値:
- 現在のラウンドが反復の最後のラウンドである場合は
true
、それ以外の場合はfalse
。
getBegin
IntegerSE getBegin()
関連するタグの 'begin' 属性の値を返します。'begin' 属性が指定されていない場合は null を返します。- 戻り値:
- 関連するタグの「開始」値。'begin' 属性が指定されていない場合は null
getEnd
IntegerSE getEnd()
関連するタグの 'end' 属性の値を返します。'end' 属性が指定されていない場合は null を返します。- 戻り値:
- 関連するタグの「終了」値。'end' 属性が指定されていない場合は null
getStep
IntegerSE getStep()
関連するタグの 'step' 属性の値を返します。'step' 属性が指定されていない場合は null を返します。- 戻り値:
- 関連するタグの「ステップ」値。'step' 属性が指定されていない場合は null