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 * @since 1.7
026 */
027public final class TreeUtils
028{
029    /** Prevent creating this class. */
030    private TreeUtils()
031    {
032    }
033
034    /**
035     * Print out the data in the configuration.
036     * @param stream The OutputStream.
037     * @param result The root node of the tree.
038     */
039    public static void printTree(final PrintStream stream, final ImmutableNode result)
040    {
041        if (stream != null)
042        {
043            printTree(stream, "", result);
044        }
045    }
046
047    private static void printTree(final PrintStream stream, final String indent, final ImmutableNode result)
048    {
049        final StringBuilder buffer = new StringBuilder(indent).append("<").append(result.getNodeName());
050        for (final Map.Entry<String, Object> e : result.getAttributes().entrySet())
051        {
052            buffer.append(' ').append(e.getKey()).append("='").append(e.getValue()).append("'");
053        }
054        buffer.append(">");
055        stream.print(buffer.toString());
056        if (result.getValue() != null)
057        {
058            stream.print(result.getValue());
059        }
060        boolean newline = false;
061        if (!result.getChildren().isEmpty())
062        {
063            stream.print("\n");
064            for (final ImmutableNode child : result.getChildren())
065            {
066                printTree(stream, indent + "  ", child);
067            }
068            newline = true;
069        }
070        if (newline)
071        {
072            stream.print(indent);
073        }
074        stream.println("</" + result.getNodeName() + ">");
075    }
076}