Java XML Element First getFirstElementByTagName(Document doc, String tagName)

Description

Returns the first element matching the given tag name.

License

Open Source License

Parameter

Parameter	Description
doc	the document from which to search the element
tagName	the name of the tag to match

Return

optional containing the element or empty if the element cannot be found

Declaration

public static Optional<Element> getFirstElementByTagName(Document doc, String tagName) 

Method Source Code

//package com.java2s;
/**//w ww .java2 s  . co m
 * The MIT License
 * Copyright (c) 2015 Estonian Information System Authority (RIA), Population Register Centre (VRK)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

import org.w3c.dom.Document;
import org.w3c.dom.Element;

import org.w3c.dom.NodeList;

import java.util.Optional;

public class Main {
    /**
     * Returns the first element matching the given tag name.
     * @param doc the document from which to search the element
     * @param tagName the name of the tag to match
     * @return optional containing the element or empty if the element cannot be found
     */
    public static Optional<Element> getFirstElementByTagName(Document doc, String tagName) {
        NodeList nodes = doc.getElementsByTagName(tagName);

        return nodes.getLength() > 0 ? Optional.ofNullable((Element) nodes.item(0)) : Optional.empty();
    }
}

Related

1. getFirstElement(Document document)
2. getFirstElement(Document document, String tagName)
3. getFirstElement(Element documentElement)
4. getFirstElement(String name, Element root)
5. getFirstElementByTagName(Document document, String name)
6. getFirstElementByTagName(Document document, String tag)
7. getFirstElementText(Document document, String tagName)
8. getFirstImageTransformElement(final Document doc)