com.amihaiemil.eoyaml.YamlNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eo-yaml Show documentation

YAML for Java 8 and above. Very similar to the JSON-P api.

There is a newer version: 8.0.6

/**
 * Copyright (c) 2016-2020, Mihai Emil Andronache
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 *  list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 * Neither the name of the copyright holder nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
package com.amihaiemil.eoyaml;

import java.util.Collection;

/**
 * YAML node.
 * @author Mihai Andronache ([email protected])
 * @version $Id: f5e30513baac204abb47938a6fcd0ce7a369783b $
 * @since 1.0.0
 * @see Spec1.2/node
 */
public interface YamlNode extends Comparable {

    /**
     * Fetch the child nodes of this node.
     * @deprecated Please use method values() instead. It does
     *  exactly the same thing, it's just a change for a more suitable
     *  name. This method will be removed in one of the future releases.
     * @return Collection of {@link YamlNode}
     */
    @Deprecated
    default Collection children() {
        return this.values();
    }

    /**
     * Fetch the values.
     * @return Collection of {@link YamlNode}
     */
    Collection values();


    /**
     * Print this node with a specified indentation.
     * @param indentation Number of preciding spaces of each line.
     * @return String
     */
    String indent(final int indentation);

}