LixM 1.0

org.lixm.core.list
クラス XMLCursor

java.lang.Object
  上位を拡張 org.lixm.core.list.XMLCursor

public class XMLCursor
extends java.lang.Object

カーソルはリスト内のモデルの位置情報をカプセル化します。

バージョン:
1.0.0
作成者:
tasogare

コンストラクタの概要
XMLCursor(XMLModelList list)
          カーソルを生成します。
 
メソッドの概要
 int dec()
          現在位置の一つ前にあるモデルの位置情報を取得します。
 int getFirst()
          リストの初めにあるモデルの位置情報を取得します。
 int getIndex()
          現在位置を返します。
 int getLast()
          リストの最後にあるモデルの位置情報を取得します。
 XMLModelList getList()
          このカーソルに対応するリストを返します。
 int getMark()
          記憶済み位置情報を返します。
 boolean hasNext()
          現在位置から見て一つ次の位置にまだモデルが存在しているか調べます。
 boolean hasPrevious()
          現在位置から見て一つ前の位置にまだモデルが存在しているか調べます。
 int inc()
          現在位置の一つ次にあるモデルの位置情報を取得します。
 int next()
          現在位置の一つ次にあるモデルの位置情報を取得します。
 int nextTag()
          次に存在する開始タグまたは終了タグの位置情報を取得します。
 int previous()
          現在位置の一つ前にあるモデルの位置情報を取得します。
 int previousTag()
          以前に存在する開始タグまたは終了タグの位置情報を取得します。
 void resetIndex()
          現在位置を初期化されたときの状態に戻します。
 void resetMark()
          記憶済み位置情報を初期化されたときの状態に戻します。
 void seek(int pos)
          現在位置を記憶し、任意の位置を現在位置に設定しなおします。
 void setIndex(int index)
          カーソルの現在位置を設定します。
 void setMark(int index)
          任意の位置情報を記憶します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

XMLCursor

public XMLCursor(XMLModelList list)

カーソルを生成します。

パラメータ:
list - モデルリスト
メソッドの詳細

getFirst

public int getFirst()

リストの初めにあるモデルの位置情報を取得します。

戻り値:
この戻り値は常に0になる筈です。

getLast

public int getLast()

リストの最後にあるモデルの位置情報を取得します。

戻り値:
この戻り値は常に size() - 1 になる筈です。
関連項目:
XMLModelList

inc

public int inc()
        throws java.lang.IndexOutOfBoundsException

現在位置の一つ次にあるモデルの位置情報を取得します。

この時、位置情報を更新します。 リスト内の次の位置にモデルが無い場合、 IndexOutOfBoundsExceptionを投げます。

戻り値:
current + 1となる値が返る。
例外:
java.lang.IndexOutOfBoundsException - hasNext()が偽を返す場合
関連項目:
next(), hasNext()

next

public int next()

現在位置の一つ次にあるモデルの位置情報を取得します。 inc()との違いは位置情報を更新しません。

戻り値:
current + 1となる値が返る。

nextTag

public int nextTag()

次に存在する開始タグまたは終了タグの位置情報を取得します。

戻り値:
タグモデルを見つけた場合その位置

hasNext

public boolean hasNext()

現在位置から見て一つ次の位置にまだモデルが存在しているか調べます。

戻り値:
次にモデルが存在しているなら真、 そうで無いなら偽を返します。
関連項目:
inc(), next()

dec

public int dec()
        throws java.lang.IndexOutOfBoundsException

現在位置の一つ前にあるモデルの位置情報を取得します。

この時、位置情報を更新します。 リスト内の前の位置にモデルが無い場合、 IndexOutOfBoundsExceptionを投げます。

戻り値:
current - 1となる値が返る。
例外:
java.lang.IndexOutOfBoundsException
関連項目:
previous(), hasPrevious()

previous

public int previous()

現在位置の一つ前にあるモデルの位置情報を取得します。 dec()との違いは位置情報を更新しません。

戻り値:
current - 1となる値が返る。

previousTag

public int previousTag()

以前に存在する開始タグまたは終了タグの位置情報を取得します。

戻り値:
タグモデルを見つけた場合その位置

hasPrevious

public boolean hasPrevious()

現在位置から見て一つ前の位置にまだモデルが存在しているか調べます。

戻り値:
前にモデルが存在しているなら真、そうで無いなら偽を返します。
関連項目:
dec(), previous()

setIndex

public void setIndex(int index)
              throws java.lang.IndexOutOfBoundsException

カーソルの現在位置を設定します。 この値はgetIndex()で取得する場合は絶対的な位置情報となり、 inc()などで取得する場合はこのメソッドで設定した 位置からの相対的な位置情報となります。

パラメータ:
index - 設定する位置情報
例外:
java.lang.IndexOutOfBoundsException - リストの範囲を超える場合に投げられます。
関連項目:
getIndex(), resetIndex(), inc(), next(), dec(), previous()

getIndex

public int getIndex()

現在位置を返します。

戻り値:
現在の絶対的な位置情報
関連項目:
setIndex(int), resetIndex()

resetIndex

public void resetIndex()

現在位置を初期化されたときの状態に戻します。

関連項目:
setIndex(int), getIndex()

setMark

public void setMark(int index)
             throws java.lang.IndexOutOfBoundsException

任意の位置情報を記憶します。

パラメータ:
index - 記憶する位置情報。
例外:
java.lang.IndexOutOfBoundsException - 実引数がリストの範囲外の場合。
関連項目:
getMark()

getMark

public int getMark()

記憶済み位置情報を返します。

戻り値:
記憶済みの位置情報
関連項目:
setMark(int)

resetMark

public void resetMark()

記憶済み位置情報を初期化されたときの状態に戻します。

関連項目:
getMark()

seek

public void seek(int pos)
          throws java.lang.IndexOutOfBoundsException

現在位置を記憶し、任意の位置を現在位置に設定しなおします。

パラメータ:
pos - 設定する現在位置。
例外:
java.lang.IndexOutOfBoundsException - リストの範囲を超える場合。

getList

public XMLModelList getList()

このカーソルに対応するリストを返します。

戻り値:
このカーソルに対応するリスト
関連項目:
XMLModelList

LixM 1.0

Copyright © 2005-2008 tasogare. All rights reserved.