Java XML Element Root createRootElement(Document doc, String name)

Description

Create root element for specified document if it does not already exist and return it

License

Open Source License

Declaration

public static Element createRootElement(Document doc, String name) 

Method Source Code

//package com.java2s;
/*//from w  w  w  .java 2s  . com
 * Copyright 2010, 2011 Institut Pasteur.
 * 
 * This file is part of ICY.
 * 
 * ICY is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * ICY is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with ICY. If not, see <http://www.gnu.org/licenses/>.
 */

import org.w3c.dom.Document;

import org.w3c.dom.Element;

public class Main {
    public static final String NODE_ROOT_NAME = "root";

    /**
     * Create root element for specified document if it does not already exist and return it
     */
    public static Element createRootElement(Document doc) {
        return createRootElement(doc, NODE_ROOT_NAME);
    }

    /**
     * Create root element for specified document if it does not already exist and return it
     */
    public static Element createRootElement(Document doc, String name) {
        return getRootElement(doc, true, name);
    }

    /**
     * Return the root element for specified document<br>
     * Create if it does not already exist with the specified name
     */
    private static Element getRootElement(Document doc, boolean create, String name) {
        if (doc != null) {
            Element result = doc.getDocumentElement();

            if ((result == null) && create) {
                result = doc.createElement(name);
                doc.appendChild(result);
            }

            return result;
        }

        return null;
    }

    /**
     * Return the root element for specified document<br>
     * Create if it does not already exist with the default {@link #NODE_ROOT_NAME}
     */
    public static Element getRootElement(Document doc, boolean create) {
        return getRootElement(doc, create, NODE_ROOT_NAME);
    }

    /**
     * Return the root element for specified document (null if not found)<br>
     */
    public static Element getRootElement(Document doc) {
        return getRootElement(doc, false);
    }
}

Related

1. createRoot(Document document, String title)
2. createRootElement(Document doc, String name)
3. createRootElement(Document doc, String rootTagName)
4. getElement(String elementName, Node rootNode)
5. getElementData(final Element root, final String elementName)
6. getElementData(final Element root, final String elementName)