Class Document

ドキュメント

XML ドキュメントの表現。

Methods

メソッド戻り値の型概要
addContent(content)Document指定されたノードをドキュメントの末尾に追加します。
addContent(index, content)Documentドキュメントの直接の子であるすべてのノードのうち、指定されたインデックスに指定されたノードを挿入します。
cloneContent()Content[]ドキュメントの直接の子であるすべてのノードの接続されていないコピーを作成します。
detachRootElement()Elementドキュメントのルート Element ノードを接続解除して返します。
getAllContent()Content[]ドキュメントの直接の子であるすべてのノードを取得します。
getContent(index)Contentドキュメントの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを取得します。
getContentSize()Integerドキュメントの直接の子であるノードの数を取得します。
getDescendants()Content[]ドキュメントの直接または間接の子であるすべてのノードを、ドキュメントに出現する順序で取得します。
getDocType()DocTypeドキュメントの DocType 宣言を取得します。
getRootElement()Elementドキュメントのルート Element ノードを取得します。
hasRootElement()Booleanドキュメントにルート Element ノードがあるかどうかを判断します。
removeContent()Content[]ドキュメントの直接の子ノードをすべて削除します。
removeContent(content)Boolean指定されたノードがドキュメントの直接の子である場合、そのノードを削除します。
removeContent(index)Contentドキュメントの直接の子であるすべてのノードの中で、指定されたインデックスのノードを削除します。
setDocType(docType)Documentドキュメントの DocType 宣言を設定します。
setRootElement(element)Documentドキュメントのルート Element ノードを設定します。

詳細なドキュメント

addContent(content)

指定されたノードをドキュメントの末尾に追加します。content 引数には、Content オブジェクト、または ContentType にリストされているタイプに対応する任意のノード オブジェクトを指定できます。ただし、1 つのドキュメントに設定できる子 Element ノードは 1 つだけです。これは暗黙的にルート Element ノードです。

パラメータ

名前説明
contentContent追加するノード

リターン

Document - ドキュメント(チェーン用)


addContent(index, content)

ドキュメントの直接の子であるすべてのノードのうち、指定されたインデックスに指定されたノードを挿入します。content 引数には、Content オブジェクトか、ContentType にリストされているタイプに対応する任意のノード オブジェクトを指定できます。ただし、ドキュメントに含めることができる子 Element ノードは 1 つだけです。これは暗黙的にルート Element ノードです。

パラメータ

名前説明
indexIntegerドキュメントの直接の子であるすべてのノードにノードを挿入するインデックス
contentContent挿入するノードです。

リターン

Document - ドキュメント(チェーン用)


cloneContent()

ドキュメントの直接の子であるすべてのノードの接続されていないコピーを作成します。

リターン

Content[] - ドキュメントの直接の子であるすべてのノードの接続されていないコピーの配列


detachRootElement()

ドキュメントのルート Element ノードを接続解除して返します。ドキュメントにルート Element ノードがない場合、このメソッドは null を返します。

リターン

Element - 分離された Element ノード。ドキュメントにルートの Element ノードがない場合は null


getAllContent()

ドキュメントの直接の子であるすべてのノードを取得します。

リターン

Content[] - ドキュメントの直接の子であるすべてのノードの配列


getContent(index)

ドキュメントの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを取得します。指定されたインデックスにノードがない場合、このメソッドは null を返します。

パラメータ

名前説明
indexIntegerドキュメントの直接の子であるすべてのノードのうちのノードのインデックス

リターン

Content - ノード、または指定されたインデックスにノードがない場合は null


getContentSize()

ドキュメントの直接の子であるノードの数を取得します。

リターン

Integer - ドキュメントの直接の子ノードの数


getDescendants()

ドキュメントの直接または間接の子であるすべてのノードを、ドキュメントに出現する順序で取得します。

リターン

Content[] - ドキュメントの直接または間接の子であるすべてのノードの配列


getDocType()

ドキュメントの DocType 宣言を取得します。ドキュメントに DocumentType ノードがない場合、このメソッドは null を返します。

リターン

DocType - DocumentType ノード。ドキュメントに DocumentType ノードがない場合は null


getRootElement()

ドキュメントのルート Element ノードを取得します。ドキュメントにルート Element ノードがない場合、このメソッドは null を返します。

リターン

Element - ルート Element ノード。ドキュメントにルート Element ノードがない場合は null


hasRootElement()

ドキュメントにルート Element ノードがあるかどうかを判断します。

リターン

Boolean - ドキュメントにルート Element ノードがある場合は true、そうでない場合は false


removeContent()

ドキュメントの直接の子ノードをすべて削除します。

リターン

Content[] - 削除されるまでドキュメントの直接の子であったすべてのノードの配列


removeContent(content)

指定されたノードがドキュメントの直接の子である場合、そのノードを削除します。content 引数には、Content オブジェクトか、ContentType にリストされているタイプに対応する任意のノード オブジェクトを指定できます。

パラメータ

名前説明
contentContentノードを削除します。

リターン

Boolean - ノードが直接の子で削除された場合は true、そうでない場合は false


removeContent(index)

ドキュメントの直接の子であるすべてのノードの中で、指定されたインデックスのノードを削除します。指定されたインデックスにノードがない場合、このメソッドは null を返します。

パラメータ

名前説明
indexIntegerドキュメントの直接の子であるすべてのノードのうちのノードのインデックス

リターン

Content - 削除されたノード。指定されたインデックスにノードがない場合は null


setDocType(docType)

ドキュメントの DocType 宣言を設定します。ドキュメントにすでに別の DocType ノードがある場合、このメソッドにより古いノードが上書きされます。設定対象と同じ DocType ノードがドキュメントにすでに含まれている場合、このメソッドは例外をスローします。

パラメータ

名前説明
docTypeDocType設定する DocumentType

リターン

Document - ドキュメント(チェーン用)


setRootElement(element)

ドキュメントのルート Element ノードを設定します。ドキュメントにすでにルート Element ノードがある場合、このメソッドにより古いノードが上書きされます。

パラメータ

名前説明
elementElement設定するルート Element ノード

リターン

Document - ドキュメント(チェーン用)