Class Document

ドキュメント

XML ドキュメントの表現。

メソッド

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

詳細なドキュメント

addContent(content)

指定されたノードをドキュメントの末尾に追加します。content 引数には、Content オブジェクトまたは ContentType にリストされている型に対応する任意のノード オブジェクトを指定できます。ただし、ドキュメントには 1 つの子 Element ノードしか含めることができません。これは暗黙的にルート Element ノードになります。

パラメータ

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

戻る

Document - チェーン用のドキュメント。

addContent(index, content)

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

パラメータ

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

戻る

Document - チェーン用のドキュメント。

cloneContent()

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

戻る

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

detachRootElement()

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

戻る

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

getAllContent()

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

戻る

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

getContent(index)

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

パラメータ

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

戻る

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

getContentSize()

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

戻る

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

getDescendants()

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

戻る

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

getDocType()

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

戻る

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

getRootElement()

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

戻る

Element|null - ルート 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 - 削除されたノード。指定されたインデックスにノードがない場合は null。

setDocType(docType)

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

パラメータ

名前型説明
docTypeDocType設定する DocumentType。

戻る

Document - チェーン用のドキュメント。

setRootElement(element)

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

パラメータ

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

戻る

Document - チェーン用のドキュメント。