Java : Node (XML) - API使用例

Node (Java SE 17 & JDK 17) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様のおともにどうぞ。

概要

NodeインタフェースはDocument Object Model全体の主要なデータ型です。これはドキュメント・ツリーの単一のノードを表します。

クラス構成

Nodeインタフェースは、Document Object Model(DOM)のもっとも基本となるデータ型です。
より具体的なElementやTextといったデータ型は、すべてNodeを実装します。

Nodeは1つの親と複数の子を持ちます。
全体としてツリー構造になります。

ノード構成

共通で使うコード

本記事のAPI使用例では、利便性のために以下のメソッドを共通処理として使います。

// DocumentをXMLでコンソールに出力します。
// 見やすくするためにインデントを付け、<?xml ～ ?>は非表示にしています。
public void printDocument(Document document) throws TransformerException {
    final var transformer = TransformerFactory.newInstance().newTransformer();
    transformer.setOutputProperty(OutputKeys.INDENT, "yes");
    transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");

    final var result = new StreamResult(new StringWriter());
    transformer.transform(new DOMSource(document), result);

    System.out.print(result.getWriter());
}

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.newDocument();

final var root = document.createElement("root");
System.out.println(root); // [root: null]

document.appendChild(root);

final var child = document.createElement("child");
System.out.println(child); // [child: null]

root.appendChild(child);

final var text = document.createTextNode("abcd");
System.out.println(text); // [#text: abcd]

child.appendChild(text);

//<root>
//    <child>abcd</child>
//</root>
printDocument(document);

フィールド

static final short ATTRIBUTE_NODE

ノードはAttrです。

final var xml = """
        <root attr="abc"/>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node attr = document.getDocumentElement().getAttributes().getNamedItem("attr");
System.out.println(attr); // attr="abc"

System.out.println(Node.ATTRIBUTE_NODE); // 2
System.out.println(attr.getNodeType() == Node.ATTRIBUTE_NODE); // true

static final short CDATA_SECTION_NODE

ノードはCDATASectionです。

final var xml = """
        <root><![CDATA[<&>]]></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node cdata = document.getDocumentElement().getFirstChild();
System.out.println(cdata); // [#cdata-section: <&>]

System.out.println(Node.CDATA_SECTION_NODE); // 4
System.out.println(cdata.getNodeType() == Node.CDATA_SECTION_NODE); // true

static final short COMMENT_NODE

ノードはCommentです。

final var xml = """
        <root><!-- abc --></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node comment = document.getDocumentElement().getFirstChild();
System.out.println(comment); // [#comment:  abc ]

System.out.println(Node.COMMENT_NODE); // 8
System.out.println(comment.getNodeType() == Node.COMMENT_NODE); // true

static final short DOCUMENT_FRAGMENT_NODE

ノードはDocumentFragmentです。

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.newDocument();

final Node fragment = document.createDocumentFragment();
System.out.println(fragment); // [#document-fragment: null]

System.out.println(Node.DOCUMENT_FRAGMENT_NODE); // 11
System.out.println(fragment.getNodeType() == Node.DOCUMENT_FRAGMENT_NODE); // true

static final short DOCUMENT_NODE

ノードはDocumentです。

final var xml = """
        <root/>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final Node document = builder.parse(new ByteArrayInputStream(xml.getBytes()));
System.out.println(document); // [#document: null]

System.out.println(Node.DOCUMENT_NODE); // 9
System.out.println(document.getNodeType() == Node.DOCUMENT_NODE); // true

static final short DOCUMENT_POSITION_CONTAINED_BY

ノードは参照ノードに含まれています。

final var xml = """
        <root><child/></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var child = root.getFirstChild();
System.out.println(child); // [child: null]

final var type = root.compareDocumentPosition(child);

System.out.println("0x%x".formatted(type)); // 0x14
System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_CONTAINED_BY)); // 0x10
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_CONTAINED_BY)); // 0x10

static final short DOCUMENT_POSITION_CONTAINS

ノードは参照ノードを含みます。

final var xml = """
        <root><child/></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var child = root.getFirstChild();
System.out.println(child); // [child: null]

final var type = child.compareDocumentPosition(root);

System.out.println("0x%x".formatted(type)); // 0xa
System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_CONTAINS)); // 0x8
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_CONTAINS)); // 0x8

static final short DOCUMENT_POSITION_DISCONNECTED

2つのノードは切断されます。

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();

final var document1 = builder.newDocument();
final var node1 = document1.createTextNode("abcd");
System.out.println(node1); // [#text: abcd]

final var document2 = builder.newDocument();
final var node2 = document2.createTextNode("xyz");
System.out.println(node2); // [#text: xyz]

final var type = node1.compareDocumentPosition(node2);

System.out.println("0x%x".formatted(type)); // 0x23
System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_DISCONNECTED)); // 0x1
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_DISCONNECTED)); // 0x1

static final short DOCUMENT_POSITION_FOLLOWING

ノードは参照ノードのあとに続きます。

final var xml = """
        <root>
            <child-a/>
            <child-b/>
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final var childA = document.getElementsByTagName("child-a").item(0);
System.out.println(childA); // [child-a: null]

final var childB = document.getElementsByTagName("child-b").item(0);
System.out.println(childB); // [child-b: null]

final var type = childA.compareDocumentPosition(childB);

System.out.println("0x%x".formatted(type)); // 0x4
System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_FOLLOWING)); // 0x4
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_FOLLOWING)); // 0x4

static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

先行するかあとにくるかは実装に固有です。

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();

final var document1 = builder.newDocument();
final var node1 = document1.createTextNode("abcd");
System.out.println(node1); // [#text: abcd]

final var document2 = builder.newDocument();
final var node2 = document2.createTextNode("xyz");
System.out.println(node2); // [#text: xyz]

final short type = node1.compareDocumentPosition(node2);

System.out.println("0x%x".formatted(type)); // 0x23
System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC)); // 0x20
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC)); // 0x20

static final short DOCUMENT_POSITION_PRECEDING

2番目のノードは参照ノードの前にあります。

final var xml = """
        <root>
            <child-a/>
            <child-b/>
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final var childA = document.getElementsByTagName("child-a").item(0);
System.out.println(childA); // [child-a: null]

final var childB = document.getElementsByTagName("child-b").item(0);
System.out.println(childB); // [child-b: null]

final var type = childB.compareDocumentPosition(childA);

System.out.println("0x%x".formatted(type)); // 0x2
System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_PRECEDING)); // 0x2
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_PRECEDING)); // 0x2

static final short DOCUMENT_TYPE_NODE

ノードはDocumentTypeです。

final var xml = """
        <!DOCTYPE root>
        <root/>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node doctype = document.getDoctype();
System.out.println(doctype); // [root: null]

System.out.println(Node.DOCUMENT_TYPE_NODE); // 10
System.out.println(doctype.getNodeType() == Node.DOCUMENT_TYPE_NODE); // true

static final short ELEMENT_NODE

ノードはElementです。

final var xml = """
        <root/>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node element = document.getDocumentElement();
System.out.println(element); // [root: null]

System.out.println(Node.ELEMENT_NODE); // 1
System.out.println(element.getNodeType() == Node.ELEMENT_NODE); // true

static final short ENTITY_NODE

ノードはEntityです。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <!DOCTYPE root [
            <!ENTITY aaa "bbb">
        ]>
        <root>&aaa;</root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node entity = document.getDoctype().getEntities().item(0);
System.out.println(entity); // [aaa: null]

System.out.println(Node.ENTITY_NODE); // 6
System.out.println(entity.getNodeType() == Node.ENTITY_NODE); // true

//<root>bbb</root>
printDocument(document);

static final short ENTITY_REFERENCE_NODE

ノードはEntityReferenceです。

final var xml = """
        <!DOCTYPE root [
            <!ENTITY aaa "bbb">
        ]>
        <root>&aaa;</root>
        """;

final var factory = DocumentBuilderFactory.newInstance();
factory.setExpandEntityReferences(false);

final var document = factory.newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

final Node entityReference = document.getDocumentElement().getFirstChild();
System.out.println(entityReference); // [aaa: null]

System.out.println(Node.ENTITY_REFERENCE_NODE); // 5
System.out.println(entityReference.getNodeType() == Node.ENTITY_REFERENCE_NODE); // true

static final short NOTATION_NODE

ノードはNotationです。

final var xml = """
        <!DOCTYPE root [
           <!NOTATION sample SYSTEM "aaa">
        ]>
        <root/>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node notation = document.getDoctype().getNotations().item(0);
System.out.println(notation); // [sample: null]

System.out.println(Node.NOTATION_NODE); // 12
System.out.println(notation.getNodeType() == Node.NOTATION_NODE); // true

static final short PROCESSING_INSTRUCTION_NODE

ノードはProcessingInstructionです。

final var xml = """
        <root><?target content?></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node pi = document.getDocumentElement().getFirstChild();
System.out.println(pi); // [target: content]

System.out.println(Node.PROCESSING_INSTRUCTION_NODE); // 7
System.out.println(pi.getNodeType() == Node.PROCESSING_INSTRUCTION_NODE); // true

static final short TEXT_NODE

ノードはTextノードです。

final var xml = """
        <root>abcd</root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node text = document.getDocumentElement().getFirstChild();
System.out.println(text); // [#text: abcd]

System.out.println(Node.TEXT_NODE); // 3
System.out.println(text.getNodeType() == Node.TEXT_NODE); // true

メソッド

Node appendChild (Node newChild)

ノードnewChildをこのノードの子のリストの末尾に追加します。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root/>
        """;

final var document = DocumentBuilderFactory.newInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final Node child = document.createElement("child");
System.out.println(child); // [child: null]

final Node ret = root.appendChild(child);
System.out.println(ret); // [child: null]

//<root>
//    <child/>
//</root>
printDocument(document);

Node cloneNode (boolean deep)

ノードのジェネリック・コピー・コンストラクタとして、このノードの複製を返します。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><a><b>xyz</b></a></root>
        """;

final var document = DocumentBuilderFactory.newInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <a>
//        <b>xyz</b>
//    </a>
//</root>
printDocument(document);

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final Node childA = document.getElementsByTagName("a").item(0);
System.out.println(childA); // [a: null]

final Node clonedDeepNode = childA.cloneNode(true);
final Node clonedNode = childA.cloneNode(false);

root.appendChild(clonedDeepNode);
root.appendChild(clonedNode);

//<root>
//    <a>
//        <b>xyz</b>
//    </a>
//    <a>
//        <b>xyz</b>
//    </a>
//    <a/>
//</root>
printDocument(document);

short compareDocumentPosition (Node other)

このメソッドが呼び出されている参照ノードを、パラメータとして渡されるノードと、文書内の位置に関して文書順に比較します。

結果は、フィールド定数の DOCUMENT_POSITION_～ になります。
DOCUMENT_POSITION_～については、各フィールド定数のAPI使用例をご確認ください。

結果は１つとは限らず、複数になることもあります。
つまり DOCUMENT_POSITION_～は論理演算で確認する必要があります。

final var xml = """
        <root>
            <child/>
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]

final short type = root.compareDocumentPosition(child);
System.out.println("0x%x".formatted(type)); // 0x14

System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_CONTAINED_BY)); // 0x10
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_CONTAINED_BY)); // 0x10

System.out.println("0x%x".formatted(Node.DOCUMENT_POSITION_FOLLOWING)); // 0x4
System.out.println("0x%x".formatted(type & Node.DOCUMENT_POSITION_FOLLOWING)); // 0x4

NamedNodeMap getAttributes ()

このノードがElementの場合、このノードの属性を含むNamedNodeMap。それ以外の場合はnull。

final var xml = """
        <root>
            <child aa="AA" bb="BB" />
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]

final var attributes = child.getAttributes();

System.out.println("-- attributes --");
for (int i = 0; i < attributes.getLength(); i++) {
    final var attr = attributes.item(i);
    System.out.println(attr);
}

// 結果
// ↓
//-- attributes --
//aa="AA"
//bb="BB"

String getBaseURI ()

このノードの絶対ベースURI。実装が絶対URIを取得できなかった場合はnull。

final var path = Path.of("R:", "java-work", "a.xml");
System.out.println(path); // R:\java-work\a.xml

Files.writeString(path, """
        <root>
            <child/>
        </root>
        """);

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(path.toFile());

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]
System.out.println(root.getBaseURI()); // file:/R:/java-work/a.xml

NodeList getChildNodes ()

このノードの子をすべて含むNodeList。

final var xml = """
        <root><child-a/><child-b/></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var nodes = root.getChildNodes();
System.out.println(nodes.getLength()); // 2

System.out.println("-- nodes --");
for (int i = 0; i < nodes.getLength(); i++) {
    System.out.println(nodes.item(i));
}

// 結果
// ↓
//-- nodes --
//[child-a: null]
//[child-b: null]

// 空白や改行はTextノードとして取得されるのでご注意ください。
// コメントもCommentノードとなります。
final var xml = """
        <root>
            <child-a/>
            <child-b/>
            <!-- comment! -->
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var nodes = root.getChildNodes();
System.out.println(nodes.getLength()); // 7

System.out.println("-- nodes --");
for (int i = 0; i < nodes.getLength(); i++) {
    final var node = nodes.item(i);
    if (node instanceof Text text) {
        // 見やすさのために、改行は \n、スペースは * に変換します。
        final var data = text.getData().replace("\n", "\\n").replace(" ", "*");
        System.out.println("[#text: " + data + "]");
    } else {
        System.out.println(node);
    }
}

// 結果
// ↓
//-- nodes --
//[#text: \n****]
//[child-a: null]
//[#text: \n****]
//[child-b: null]
//[#text: \n****]
//[#comment:  comment! ]
//[#text: \n]

Object getFeature (String feature, String version)

このメソッドは、指定した機能とバージョンを持つ特殊な形式のAPIを指定されたとおりに実装する特殊な形式のオブジェクトを返します。

final var xml = """
        <root>abcd</root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

System.out.println(root.isSupported("XML", "3.0")); // true
System.out.println(root.getFeature("XML", "3.0")); // [root: null]

System.out.println(root.isSupported("XML", "4.0")); // false
System.out.println(root.getFeature("XML", "4.0")); // null

Node getFirstChild ()

このノードの最初の子ノードです。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><child-a/><child-b/><child-c/></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child-a/>
//    <child-b/>
//    <child-c/>
//</root>
printDocument(document);

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final Node firstChild = root.getFirstChild();
System.out.println(firstChild); // [child-a: null]

final Node lastChild = root.getLastChild();
System.out.println(lastChild); // [child-c: null]

Node getLastChild ()

このノードの最後の子ノードです。

このメソッドの使用例は、getFirstChild() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

String getLocalName ()

このノードの修飾名のローカル部分を返します。

final var xml = """
        <ns:root xmlns:ns="sample">
            <ns:child/>
        </ns:root>
        """;

final var builder = DocumentBuilderFactory.newNSInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node child = document.getElementsByTagName("ns:child").item(0);
System.out.println(child); // [ns:child: null]

System.out.println(child.getPrefix()); // ns
System.out.println(child.getLocalName()); // child
System.out.println(child.getNamespaceURI()); // sample

String getNamespaceURI ()

このノードの名前空間URI。未指定の場合はnull。

このメソッドの使用例は、getLocalName() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

Node getNextSibling ()

このノードの直後のノードです。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><child-a/><child-b/></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child-a/>
//    <child-b/>
//</root>
printDocument(document);

final Node childA = document.getDocumentElement().getFirstChild();
System.out.println(childA); // [child-a: null]

final Node childB = childA.getNextSibling();
System.out.println(childB); // [child-b: null]

final Node childC = childB.getNextSibling();
System.out.println(childC); // null

String getNodeName ()

このノードの名前です。この名前は型によって異なります。上記の表を参照してください。

final var xml = """
        <root>
            <child aa="AA">abcd</child>
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

// Element
final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child.getNodeType() == Node.ELEMENT_NODE); // true
System.out.println(child.getNodeName()); // child
System.out.println(child.getNodeValue()); // null

// Attr
final Node attr = child.getAttributes().item(0);
System.out.println(attr.getNodeType() == Node.ATTRIBUTE_NODE); // true
System.out.println(attr.getNodeName()); // aa
System.out.println(attr.getNodeValue()); // AA

// Text
final Node text = child.getFirstChild();
System.out.println(text.getNodeType() == Node.TEXT_NODE); // true
System.out.println(text.getNodeName()); // #text
System.out.println(text.getNodeValue()); // abcd

short getNodeType ()

オブジェクトの型を表すコードです。上記の定義を参照してください。

このメソッドの使用例は、getNodeName() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

String getNodeValue ()

このノードの値です。この値は型によって異なります。前述の表を参照してください。

このメソッドの使用例は、getNodeName() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

Document getOwnerDocument ()

このノードに関連付けられたDocumentオブジェクト。

final var xml = """
        <root>
            <child/>
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]

final var ownerDocument = child.getOwnerDocument();
System.out.println(document.isSameNode(ownerDocument)); // true

Node getParentNode ()

このノードの親ノードです。

final var xml = """
        <root>
            <child>
                <child-child/>
            </child>
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node childChild = document.getElementsByTagName("child-child").item(0);
System.out.println(childChild); // [child-child: null]

final Node child = childChild.getParentNode();
System.out.println(child); // [child: null]

final Node root = child.getParentNode();
System.out.println(root); // [root: null]

String getPrefix ()

このノードの名前空間接頭辞です。未指定の場合はnullになります。

このメソッドの使用例は、getLocalName() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

Node getPreviousSibling ()

このノードの直前のノードです。

final var xml = """
        <root><child-y/><child-z/></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child-y/>
//    <child-z/>
//</root>
printDocument(document);

final Node childZ = document.getDocumentElement().getLastChild();
System.out.println(childZ); // [child-z: null]

final Node childY = childZ.getPreviousSibling();
System.out.println(childY); // [child-y: null]

final Node childX = childY.getPreviousSibling();
System.out.println(childX); // null

String getTextContent ()

この属性は、指定されたノードとノードの子孫のテキスト・コンテンツを返します。

final var xml = """
        <root>aaa<child>XYZ</child>bbb</root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]
System.out.println(root.getTextContent()); // aaaXYZbbb

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]
System.out.println(child.getTextContent()); // XYZ

Object getUserData (String key)

このノードのキーに関連付けられたオブジェクトを取得します。

final var xml = """
        <root>
            <child-a/>
            <child-b/>
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node childA = document.getElementsByTagName("child-a").item(0);
System.out.println(childA); // [child-a: null]

final Node childB = document.getElementsByTagName("child-b").item(0);
System.out.println(childB); // [child-b: null]

final var handler = new UserDataHandler() {
    @Override
    public void handle(short operation, String key, Object data, Node src, Node dst) {
        System.out.println("-- UserDataHandler.handle --");
        System.out.println(
                "operation = " + operation + " : key = " + key +
                        " : data = " + data + " : src = " + src + " : dst = " + dst);
    }
};

final var retA = childA.setUserData("a-key", "aaa", handler);
System.out.println(retA); // null

final var retB = childB.setUserData("b-key", "bbb", handler);
System.out.println(retB); // null

System.out.println(childA.getUserData("a-key")); // aaa
System.out.println(childA.getUserData("b-key")); // null

System.out.println(childB.getUserData("a-key")); // null
System.out.println(childB.getUserData("b-key")); // bbb

final var clonedNode = childA.cloneNode(false);

// 結果
// ↓
//-- UserDataHandler.handle --
//operation = 1 : key = a-key : data = aaa : src = [child-a: null] : dst = [child-a: null]

final var renamedNode = document.renameNode(childB, null, "child-z");

// 結果
// ↓
//-- UserDataHandler.handle --
//operation = 4 : key = b-key : data = bbb : src = [child-z: null] : dst = null

boolean hasAttributes ()

このノードが要素である場合、属性を持っているかどうかを判断します。

final var xml = """
        <root>
            <child-a/>
            <child-b aa="AA" />
        </root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node childA = document.getElementsByTagName("child-a").item(0);
System.out.println(childA); // [child-a: null]
System.out.println(childA.hasAttributes()); // false

final Node childB = document.getElementsByTagName("child-b").item(0);
System.out.println(childB); // [child-b: null]
System.out.println(childB.hasAttributes()); // true

boolean hasChildNodes ()

このノードが子ノードを持っているかどうかを判断します。

final var xml = """
        <root><child/></root>
        """;

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]
System.out.println(root.hasChildNodes()); // true
System.out.println(root.getChildNodes().getLength()); // 1

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]
System.out.println(child.hasChildNodes()); // false
System.out.println(child.getChildNodes().getLength()); // 0

Node insertBefore (Node newChild, Node refChild)

既存のrefChild子ノードの前にnewChildノードを挿入します。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><child-z/></root>
        """;

final var document = DocumentBuilderFactory.newInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child-z/>
//</root>
printDocument(document);

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final Node childZ = document.getElementsByTagName("child-z").item(0);
System.out.println(childZ); // [child-z: null]

final Node childX = document.createElement("child-x");
final Node ret1 = root.insertBefore(childX, childZ);
System.out.println(ret1); // [child-x: null]

final Node childY = document.createElement("child-y");
final Node ret2 = root.insertBefore(childY, childZ);
System.out.println(ret2); // [child-y: null]

//<root>
//    <child-x/>
//    <child-y/>
//    <child-z/>
//</root>
printDocument(document);

boolean isDefaultNamespace (String namespaceURI)

このメソッドは、指定されたnamespaceURIがデフォルトの名前空間であるかどうかをチェックします。

final var xml = """
        <root xmlns="sample1" xmlns:ns="sample2">
            <child-a/>
            <ns:child-b/>
        </root>
        """;

final var builder = DocumentBuilderFactory.newNSInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node childA = document.getElementsByTagName("child-a").item(0);
System.out.println(childA); // [child-a: null]

System.out.println(childA.getNamespaceURI()); // sample1
System.out.println(childA.isDefaultNamespace("sample1")); // true
System.out.println(childA.isDefaultNamespace("sample2")); // false

final Node childB = document.getElementsByTagName("ns:child-b").item(0);
System.out.println(childB); // [ns:child-b: null]

System.out.println(childB.getNamespaceURI()); // sample2
System.out.println(childB.isDefaultNamespace("sample1")); // true
System.out.println(childB.isDefaultNamespace("sample2")); // false

boolean isEqualNode (Node arg)

2つのノードが等しいかどうかをテストします。

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.newDocument();

final Node nodeA1 = document.createElement("node-a");
final Node nodeA2 = document.createElement("node-a");

final Node nodeB = document.createElement("node-b");

System.out.println(nodeA1.isEqualNode(nodeA1)); // true
System.out.println(nodeA1.isEqualNode(nodeA2)); // true
System.out.println(nodeA1.isEqualNode(nodeB)); // false

System.out.println(nodeA1.isSameNode(nodeA1)); // true
System.out.println(nodeA1.isSameNode(nodeA2)); // false
System.out.println(nodeA1.isSameNode(nodeB)); // false

boolean isSameNode (Node other)

このノードが指定されたノードと同じノードであるかどうかを返します。

このメソッドの使用例は、isEqualNode(Node arg) にまとめて記載しました。
そちらのAPI使用例をご参照ください。

boolean isSupported (String feature, String version)

DOM実装が特定の機能を実装しており、このノードがその機能を指定されたとおりにサポートしているかどうかを判定します。

このメソッドの使用例は、getFeature(String feature, String version) にまとめて記載しました。
そちらのAPI使用例をご参照ください。

String lookupNamespaceURI (String prefix)

指定したノードから開始して、所定の接頭辞に関連する名前空間URIを検索します。

final var xml = """
        <root xmlns:ns1="sample1">
            <ns1:child-a>
                <ns2:child-b xmlns:ns2="sample2"/>
            </ns1:child-a>
        </root>
        """;

final var builder = DocumentBuilderFactory.newNSInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node childA = document.getElementsByTagName("ns1:child-a").item(0);
System.out.println(childA); // [ns1:child-a: null]

System.out.println(childA.lookupNamespaceURI("ns1")); // sample1
System.out.println(childA.lookupNamespaceURI("ns2")); // null

final Node childB = document.getElementsByTagName("ns2:child-b").item(0);
System.out.println(childB); // [ns2:child-b: null]

System.out.println(childB.lookupNamespaceURI("ns1")); // sample1
System.out.println(childB.lookupNamespaceURI("ns2")); // sample2

String lookupPrefix (String namespaceURI)

指定されたノードから開始して、所定の名前空間URIに関連する接頭辞を検索します。

final var xml = """
        <root xmlns:ns1="sample1">
            <ns1:child-a>
                <ns2:child-b xmlns:ns2="sample2"/>
            </ns1:child-a>
        </root>
        """;

final var builder = DocumentBuilderFactory.newNSInstance().newDocumentBuilder();
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Node childA = document.getElementsByTagName("ns1:child-a").item(0);
System.out.println(childA); // [ns1:child-a: null]

System.out.println(childA.lookupPrefix("sample1")); // ns1
System.out.println(childA.lookupPrefix("sample2")); // null

final Node childB = document.getElementsByTagName("ns2:child-b").item(0);
System.out.println(childB); // [ns2:child-b: null]

System.out.println(childB.lookupPrefix("sample1")); // ns1
System.out.println(childB.lookupPrefix("sample2")); // ns2

void normalize ()

このNodeのサブツリーの最深部までに存在するすべてのTextノード(属性ノードを含む)を、Textノードが構造(要素、コメント、処理命令、CDATAセクション、エンティティ参照など)のみによって分離される、「正規」形式にします。その結果、隣接するTextノードも空のTextノードも存在しない状態になります。

final var builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
final var document = builder.newDocument();

final Node root = document.createElement("root");

// 意図的にTextノードを不必要に分割して作成します。
root.appendChild(document.createTextNode("aaa"));
root.appendChild(document.createTextNode("bbb"));

root.appendChild(document.createElement("child"));

root.appendChild(document.createTextNode(""));

{
    final var nodes = root.getChildNodes();
    for (int i = 0; i < nodes.getLength(); i++) {
        System.out.println(nodes.item(i));
    }

    // 結果
    // ↓
    //[#text: aaa]
    //[#text: bbb]
    //[child: null]
    //[#text: ]
}

// 結合可能なTextは結合されます。空のTextは削除されます。
root.normalize();

{
    final var nodes = root.getChildNodes();
    for (int i = 0; i < nodes.getLength(); i++) {
        System.out.println(nodes.item(i));
    }

    // 結果
    // ↓
    //[#text: aaabbb]
    //[child: null]
}

Node removeChild (Node oldChild)

子リストからoldChildで示される子ノードを削除し、この子ノードを返します。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><child>abcd</child></root>
        """;

final var document = DocumentBuilderFactory.newInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child>abcd</child>
//</root>
printDocument(document);

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]

final Node ret = root.removeChild(child);
System.out.println(ret); // [child: null]

//<root/>
printDocument(document);

Node replaceChild (Node newChild, Node oldChild)

子リストの中の子ノードoldChildをnewChildで置き換え、oldChildノードを返します。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><child-a>abcd</child-a></root>
        """;

final var document = DocumentBuilderFactory.newInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child-a>abcd</child-a>
//</root>
printDocument(document);

final Node root = document.getDocumentElement();
System.out.println(root); // [root: null]

final Node childA = document.getElementsByTagName("child-a").item(0);
System.out.println(childA); // [child-a: null]

final Node childB = document.createElement("child-b");
childB.appendChild(document.createTextNode("XYZ"));

final Node ret = root.replaceChild(childB, childA);
System.out.println(ret); // [child-a: null]

//<root>
//    <child-b>XYZ</child-b>
//</root>
printDocument(document);

void setNodeValue (String nodeValue)

このノードの値です。この値は型によって異なります。前述の表を参照してください。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><child aa="AA"/></root>
        """;

final var document = DocumentBuilderFactory.newInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child aa="AA"/>
//</root>
printDocument(document);

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]

final Node attr = child.getAttributes().item(0);
attr.setNodeValue("XYZ");

//<root>
//    <child aa="XYZ"/>
//</root>
printDocument(document);

void setPrefix (String prefix)

このノードの名前空間接頭辞です。未指定の場合はnullになります。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <ns:root xmlns:ns="sample"><ns:child/></ns:root>
        """;

final var document = DocumentBuilderFactory.newNSInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

//<ns:root xmlns:ns="sample">
//    <ns:child/>
//</ns:root>
printDocument(document);

final Node child = document.getElementsByTagName("ns:child").item(0);
System.out.println(child); // [ns:child: null]

child.setPrefix("xx");

//<ns:root xmlns:ns="sample">
//    <xx:child xmlns:xx="sample"/>
//</ns:root>
printDocument(document);

void setTextContent (String textContent)

この属性は、指定されたノードとノードの子孫のテキスト・コンテンツを返します。

printDocumentメソッドについてはこちらをご参照ください。

final var xml = """
        <root><child/></root>
        """;

final var document = DocumentBuilderFactory.newInstance()
        .newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes()));

//<root>
//    <child/>
//</root>
printDocument(document);

final Node child = document.getElementsByTagName("child").item(0);
System.out.println(child); // [child: null]

child.setTextContent("abcd");

//<root>
//    <child>abcd</child>
//</root>
printDocument(document);

Object setUserData (String key, Object data, UserDataHandler handler)

このノードのキーにオブジェクトを関連付けます。

このメソッドの使用例は、getUserData(String key) にまとめて記載しました。
そちらのAPI使用例をご参照ください。

XML (DOM) の基本

API 使用例
- DocumentBuilder
- DocumentBuilderFactory
- DOMImplementation
- DOMImplementationLS
- LSSerializer
- Node
  - Attr
  - CharacterData
  - Comment
  - Document
  - Element
  - Entity
  - EntityReference
  - Text
- Transformer
- TransformerFactory

Java : Node (XML) - API使用例

概要

共通で使うコード

フィールド

static final short ATTRIBUTE_NODE

static final short CDATA_SECTION_NODE

static final short COMMENT_NODE

static final short DOCUMENT_FRAGMENT_NODE

static final short DOCUMENT_NODE

static final short DOCUMENT_POSITION_CONTAINED_BY

static final short DOCUMENT_POSITION_CONTAINS

static final short DOCUMENT_POSITION_DISCONNECTED

static final short DOCUMENT_POSITION_FOLLOWING

static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

static final short DOCUMENT_POSITION_PRECEDING

static final short DOCUMENT_TYPE_NODE

static final short ELEMENT_NODE

static final short ENTITY_NODE

static final short ENTITY_REFERENCE_NODE

static final short NOTATION_NODE

static final short PROCESSING_INSTRUCTION_NODE

static final short TEXT_NODE

メソッド

Node appendChild (Node newChild)

Node cloneNode (boolean deep)

short compareDocumentPosition (Node other)

NamedNodeMap getAttributes ()

String getBaseURI ()

NodeList getChildNodes ()

Object getFeature (String feature, String version)

Node getFirstChild ()

Node getLastChild ()

String getLocalName ()

String getNamespaceURI ()

Node getNextSibling ()

String getNodeName ()

short getNodeType ()

String getNodeValue ()

Document getOwnerDocument ()

Node getParentNode ()

String getPrefix ()

Node getPreviousSibling ()

String getTextContent ()

Object getUserData (String key)

boolean hasAttributes ()

boolean hasChildNodes ()

Node insertBefore (Node newChild, Node refChild)

boolean isDefaultNamespace (String namespaceURI)

boolean isEqualNode (Node arg)

boolean isSameNode (Node other)

boolean isSupported (String feature, String version)

String lookupNamespaceURI (String prefix)

String lookupPrefix (String namespaceURI)

void normalize ()

Node removeChild (Node oldChild)

Node replaceChild (Node newChild, Node oldChild)

void setNodeValue (String nodeValue)

void setPrefix (String prefix)

void setTextContent (String textContent)

Object setUserData (String key, Object data, UserDataHandler handler)

関連記事