ts.util.resource.hierarchy
クラス Element

java.lang.Object
  上位を拡張 ts.util.resource.hierarchy.Element

public class Element
extends java.lang.Object

階層構造を持つ要素クラス。

バージョン:
$Revision: 1.1.1.1 $, $Date: 2010-10-16 00:03:50 $
作成者:
佐藤隆之.

コンストラクタの概要
Element(java.lang.String name)
          要素名を引数にもつコンストラクタ。
 
メソッドの概要
 void addChild(Element child)
          子要素を追加する。
static Element createRootElement()
          ルート要素を作成する。
 java.util.List<Element> getAllChildren()
          この要素の全ての子要素を列挙する。
 AttributeMap getAttributes()
          この要素の属性を格納したマップを取得する。
 java.util.List<Element> getChildren(java.lang.String name)
          指定された要素名を持つ全ての子要素を格納したリストを取得する。
 Element getFirstChild(java.lang.String name)
          指定された要素名をもつ最初の子要素を取得する。
 java.lang.String getName()
          要素名を取得する。
 Element getParent()
          親要素を取得する。
 java.lang.String getValue()
          要素の値を取得する。
 java.lang.String putAttribute(java.lang.String name, java.lang.String value)
          属性を設定する。
 void removeAllChildren()
          この要素の全ての子要素を削除する。
 void removeChildren(java.lang.String name)
          指定された要素名を持つ全ての子要素を削除する。
 java.lang.String setValue(java.lang.String value)
          要素の値を設定する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Element

public Element(java.lang.String name)
要素名を引数にもつコンストラクタ。

パラメータ:
name - 要素名。
例外:
java.lang.AssertionError - 要素名がヌル又は空文字列の場合。
メソッドの詳細

createRootElement

public static Element createRootElement()
ルート要素を作成する。
ルート要素は、リソースを構成する要素のトップに位置する要素のことを言い、 要素名も要素値も空、属性は持たず、子要素の数は1つだけという特徴をもつ。

戻り値:
作成されたルート要素。

getName

public java.lang.String getName()
要素名を取得する。

戻り値:
要素名。

getValue

public java.lang.String getValue()
要素の値を取得する。

戻り値:
要素の値。

setValue

public java.lang.String setValue(java.lang.String value)
要素の値を設定する。
引数がヌルの場合は、そのままヌルを設定する。

パラメータ:
value - 要素の値。
戻り値:
前回の要素値。

getParent

public Element getParent()
親要素を取得する。

戻り値:
親要素。

getAttributes

public AttributeMap getAttributes()
この要素の属性を格納したマップを取得する。

戻り値:
この要素の属性を格納したマップ。

putAttribute

public java.lang.String putAttribute(java.lang.String name,
                                     java.lang.String value)
属性を設定する。

パラメータ:
name - 属性名。
value - 属性値。
戻り値:
前回の属性値。
例外:
java.lang.AssertionError - 引数がヌル又は属性名が空文字列の場合。

addChild

public void addChild(Element child)
子要素を追加する。

パラメータ:
child - 子要素。
例外:
java.lang.AssertionError - 引数がヌルの場合。

removeChildren

public void removeChildren(java.lang.String name)
指定された要素名を持つ全ての子要素を削除する。

パラメータ:
name - 要素名。
例外:
java.lang.AssertionError - 引数がヌルの場合。

removeAllChildren

public void removeAllChildren()
この要素の全ての子要素を削除する。


getFirstChild

public Element getFirstChild(java.lang.String name)
指定された要素名をもつ最初の子要素を取得する。
指定された要素名をもつ子要素が一つも存在しない場合はヌルを返す。

パラメータ:
name - 要素名。
戻り値:
指定された要素名をもつ最初の子要素。
例外:
java.lang.AssertionError - 引数がヌルの場合。

getChildren

public java.util.List<Element> getChildren(java.lang.String name)
指定された要素名を持つ全ての子要素を格納したリストを取得する。
指定された要素名を持つ子要素が一つも存在しない場合は空のリストを返す。

パラメータ:
name - 要素名。
戻り値:
指定された要素名を持つ全ての子要素を格納したリスト。
例外:
java.lang.AssertionError - 引数がヌルの場合。

getAllChildren

public java.util.List<Element> getAllChildren()
この要素の全ての子要素を列挙する。

戻り値:
全ての子要素を格納した列挙オブジェクト。


Copyright (C) SATOH Takayuki All Rights Reserved.