javax.servlet.jsp.jstl.core
インタフェース LoopTagStatus

public interface LoopTagStatus

反復の現在の状態を表現するオブジェクトのためのインタフェースを提供します． JSTL 1.0 は LoopTags のためのメカニズムを提供します．このメカニズムは， 反復における現在のインデックスについての情報と，現在の回が反復の開始か最後かを 判定するのに便利なメソッドとを提供します． また，LoopTagStatusの実装者が反復の範囲，増分，現在のオブジェクトに関する情報を得るために status object を使用することができます．

さらに多くの状態をもつ環境はこのインタフェースを継承して実現できます．

作成者:

Shawn Bayern

メソッドの概要

java.lang.Integer	getBegin() 関連するタグのための 'begin' 値．'
int	getCount() 反復の現在の回の "count" を取り出します．
java.lang.Object	getCurrent() 反復における現在のアイテムを取り出します．等冪な振る舞い; getCurrent()を繰り返し呼び出すと反復が進まない限り同じObjectを返します．
java.lang.Integer	getEnd() 関連するタグのための 'end' 値, 'end'属性が指定されていない場合は nullを返します．
int	getIndex() 反復の現在の回におけるインデックスを取り出します．
java.lang.Integer	getStep() 関連するタグのための 'step' 値．'
boolean	isFirst() 現在の反復の回が最初の回であるかに関する情報を返します．
boolean	isLast() 現在の反復の回が最後の回であるかに関する情報を返します．

メソッドの詳細

getCurrent

public java.lang.Object getCurrent()

反復における現在のアイテムを取り出します．等冪な振る舞い; getCurrent()を繰り返し呼び出すと反復が進まない限り同じObjectを返します． (明確に言えば，getCurrent()を呼ぶことは、反復を進めません．)

戻り値:

現在のアイテム(object)

getIndex

public int getIndex()

反復の現在の回におけるインデックスを取り出します． もし反復が本質的な配列, java.lang.Collection, もしくは他の型, の部分集合上で実行されている場合は， 返されるインデックスは，本質的なコレクション内の絶対的な位置です． (訳注：getCountと比較して下さい) インデックスは0から始まります．

戻り値:

現在の反復のインデックス(インデックスは0から始まる)

getCount

public int getCount()

反復の現在の回の "count" を取り出します． countは相対的な値です．1から始まる連続のシーケンス番号です．この番号は現在の反復の"round"を一意にします． (すべてのroundsにおけるコンテキスト内では現在の反復は実行するでしょう).

例としては，begin = 5, end = 15, step = 5 で指定された反復においては， count は順番に 1, 2, 3, ... となります．

戻り値:

現在まで反復した回数(回数は1から始まる)

isFirst

public boolean isFirst()

現在の反復の回が最初の回であるかに関する情報を返します． この現在の回は getIndex() != 0 の時でさえも，'first' です． なぜなら，'index' は， その本質的なコレクションにあるコンテキストの現在の 'item'の絶対的なインデックス を参照しているからです． isFirst() の結果が true ということは，getCount() == 1 であることを暗黙的に意味します.

戻り値:

現在の回が反復の開始のときはtrue，それ以外はfalse．

isLast

public boolean isLast()

現在の反復の回が最後の回であるかに関する情報を返します． isFirst()と同様，部分集合化は考慮されます． isLast()は必ずしもunderlying反復の状態を問い合わせるとは限りません; isLast()は現在の回がこのLoopTagStatusと関連するタグにとって最終回の反復であるか否かを問い合わせます．

戻り値:

現在の回が最後の反復のときはtrue，それ以外はfalse．

getBegin

public java.lang.Integer getBegin()

関連するタグのための 'begin' 値．'begin'属性が指定されていない場合は nullを返します．

戻り値:

関連するタグのための 'begin' 値．'begin'属性が指定されていない場合は null

getEnd

public java.lang.Integer getEnd()

関連するタグのための 'end' 値, 'end'属性が指定されていない場合は nullを返します．

戻り値:

関連するタグのための 'end' 値．'end'属性が指定されていない場合は null

getStep

public java.lang.Integer getStep()

関連するタグのための 'step' 値．'step'属性が指定されていない場合は nullを返します．

戻り値:

関連するタグのための 'step' 値． 'step'属性が指定されていない場合は null