com.amihaiemil.eoyaml.YamlStream 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;
import java.util.stream.Stream;

/**
 * A YAML Stream of documents. Documents are separated by 3 dashes (---).
 * @author Mihai Andronache ([email protected])
 * @version $Id: c6fb390edea0166a906437221e9be9fbc4bdd401 $
 * @since 3.1.1
 */
public interface YamlStream extends YamlNode, Stream {

    /**
     * Indent this YamlStream. It will take all elements and separate
     * them with "---". It also starts with "---".
     * If the YamlStream is empty, it will just print: 
     *      * ---
     * ...
     * 
     * 
     * Here is an example of printed YamlStream:
     *      * ---
     *   architect: amihaiemil
     *   developers: 
     *     - amihaiemil
     *     - salikjan
     * ---
     *   architect: yegor256
     *   developers: 
     *     - paolo
     *     - mario
     * 
     * @param indentation Integer specifying the root indentation level.
     *  Usually 0, but it may be greater than 0 if this YamlNode should
     *  be nested within a bigger YAML.
     * @return String.
     */
    default String indent(final int indentation) {
        if(indentation < 0) {
            throw new IllegalArgumentException(
                "Indentation level has to be >=0"
            );
        }
        final StringBuilder print = new StringBuilder();
        int spaces = indentation;
        final StringBuilder indent = new StringBuilder();
        while (spaces > 0) {
            indent.append(" ");
            spaces--;
        }
        final Collection values = this.values();
        String printed;
        if(values.size() == 0) {
            print
                .append(indent).append("---\n")
                .append(indent).append("...");
            printed = print.toString();
        } else {
            for (final YamlNode node : values) {
                print.append(indent)
                     .append("---\n");
                print.append(node.indent(indentation + 2));
                print.append("\n");
            }
            printed = print.toString();
            if(printed.length() > 0) {
                printed = printed.substring(0, printed.length() - 1);
            }
        }
        return printed;
    }
    
}