/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package groovy.util;

import java.util.Map;

/**
 * A helper class for creating nested trees of Node objects for
 * handling arbitrary data
 */
public class NodeBuilder extends BuilderSupport {

    /**
     * Creates a new {@code NodeBuilder}.
     *
     * @return a new builder instance
     */
    public static NodeBuilder newInstance() {
        return new NodeBuilder();
    }

    /** {@inheritDoc} */
    @Override
    protected void setParent(Object parent, Object child) {
    }

    /** {@inheritDoc} */
    @Override
    protected Object createNode(Object name) {
        return new Node(getCurrentNode(), name);
    }

    /** {@inheritDoc} */
    @Override
    protected Object createNode(Object name, Object value) {
        return new Node(getCurrentNode(), name, value);
    }

    /** {@inheritDoc} */
    @Override
    protected Object createNode(Object name, Map attributes) {
        return new Node(getCurrentNode(), name, attributes);
    }

    /** {@inheritDoc} */
    @Override
    protected Object createNode(Object name, Map attributes, Object value) {
        return new Node(getCurrentNode(), name, attributes, value);
    }

    /**
     * Returns the current node being built.
     *
     * @return the current node, or {@code null} if none is active
     */
    protected Node getCurrentNode() {
        return (Node) getCurrent();
    }
}
