javax.swing.text
クラス ElementIterator

java.lang.Object
  |
  +--javax.swing.text.ElementIterator

public class ElementIterator

extends Object

implements Cloneable

ElementIterator は、その名前が示すとおり、要素ツリーを繰り返し処理します。コンストラクタを呼び出すには、ドキュメントまたは要素を引数に使います。ドキュメントを引数としてコンストラクタを呼び出すと、繰り返しのルートは document.getDefaultRootElement() の戻り値になります。 繰り返しは深さ優先方式で実行されます。以下に、境界条件の処理方法の観点から説明します。

1. next() が first() または current() の前に呼び出された場合は、ルートが返される
2. next() は null を返してリストの末尾を示す
3. 現在の要素がルートのときや next() が null を返したときは、previous() は null を返す

ElementIterator は要素ツリーをロックしません。つまり、ElementIterator はどのような変更も追跡しません。このクラスのユーザが、要素の繰り返し処理で変更が生じていないことを確認する必要があります。 次に、簡単な使用例を示します。

	public void iterate() {
		ElementIterator it = new ElementIterator(root);
	  Element elem;
	  while (true) {
		   if ((elem = next()) != null) {
		 // process element
		 System.out.println("elem: " + elem.getName());
		 } else {
			 break;
		 }
	  }
	}

コンストラクタの概要

ElementIterator(Document document)
新しい ElementIterator を作成します。

ElementIterator(Element root)
新しい ElementIterator を作成します。

メソッドの概要

Object	clone() ElementIterator を複製します。
Element	current() 現在の Element を取得します。
int	depth() 要素ツリーの現在の深さを取得します。
Element	first() 先頭の要素を取得します。
Element	next() 次の要素を取得します。
Element	previous() 直前の要素を取得します。

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

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ElementIterator

public ElementIterator(Document document)

新しい ElementIterator を作成します。ルート要素を取り込むと、ドキュメントのデフォルトのルート要素を取得できます。

パラメータ:

document - ドキュメント

ElementIterator

public ElementIterator(Element root)

新しい ElementIterator を作成します。

パラメータ:

root - ルートの要素

メソッドの詳細

clone

public Object clone()

ElementIterator を複製します。

戻り値:

複製した ElementIterator オブジェクト

オーバーライド:

クラス Object 内の clone

first

public Element first()

先頭の要素を取得します。

戻り値:

Element

depth

public int depth()

要素ツリーの現在の深さを取得します。

戻り値:

深さ

current

public Element current()

現在の Element を取得します。

戻り値:

スタック上の要素。ルート要素が無効な場合は null

next

public Element next()

次の要素を取得します。次の要素を見つけるには深さ優先探索が使われます。

戻り値:

次の要素。リスト末尾では null

previous

public Element previous()

直前の要素を取得します。現在の要素が最後の要素か null の場合は、null が返されます。

戻り値:

利用できる場合は前の要素