001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.configuration2.tree;
018
019import java.io.PrintStream;
020import java.util.Map;
021
022/**
023 * Utility methods.
024 *
025 * @version $Id: TreeUtils.java 1624601 2014-09-12 18:04:36Z oheger $
026 * @since 1.7
027 */
028public final class TreeUtils
029{
030    /** Prevent creating this class. */
031    private TreeUtils()
032    {
033    }
034
035    /**
036     * Print out the data in the configuration.
037     * @param stream The OutputStream.
038     * @param result The root node of the tree.
039     */
040    public static void printTree(PrintStream stream, ImmutableNode result)
041    {
042        if (stream != null)
043        {
044            printTree(stream, "", result);
045        }
046    }
047
048    private static void printTree(PrintStream stream, String indent, ImmutableNode result)
049    {
050        StringBuilder buffer = new StringBuilder(indent).append("<").append(result.getNodeName());
051        for (Map.Entry<String, Object> e : result.getAttributes().entrySet())
052        {
053            buffer.append(' ').append(e.getKey()).append("='").append(e.getValue()).append("'");
054        }
055        buffer.append(">");
056        stream.print(buffer.toString());
057        if (result.getValue() != null)
058        {
059            stream.print(result.getValue());
060        }
061        boolean newline = false;
062        if (!result.getChildren().isEmpty())
063        {
064            stream.print("\n");
065            for (ImmutableNode child : result.getChildren())
066            {
067                printTree(stream, indent + "  ", child);
068            }
069            newline = true;
070        }
071        if (newline)
072        {
073            stream.print(indent);
074        }
075        stream.println("</" + result.getNodeName() + ">");
076    }
077}