com.amihaiemil.eoyaml.RtYamlScalarBuilder 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.
The newest version!
/**
 * Copyright (c) 2016-2024, 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.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Implementation for {@link YamlScalarBuilder}. "Rt" stands for "Runtime.
 * This class is immutable and thread-safe.
 * @author Mihai Andronache ([email protected])
 * @version $Id: 6b04a6743c9ee5ee8d96674b6a9376573fd907bb $
 * @since 4.0.0
 */
final class RtYamlScalarBuilder implements YamlScalarBuilder {

    /**
     * Added lines.
     */
    private final List lines;

    /**
     * Default ctor.
     */
    RtYamlScalarBuilder() {
        this(new LinkedList<>());
    }

    /**
     * Constructor.
     * @param lines String lines of the Scalar.
     */
    RtYamlScalarBuilder(final List lines) {
        this.lines = lines;
    }

    @Override
    public YamlScalarBuilder addLine(final String value) {
        final List all = new LinkedList<>();
        all.addAll(this.lines);
        all.add(value);
        return new RtYamlScalarBuilder(all);
    }

    @Override
    public Scalar buildPlainScalar(final String above, final String inline) {
        final String plain = this.lines.stream().filter(line -> line!=null).map(
            line -> line.replaceAll(System.lineSeparator(), " ")
        ).collect(Collectors.joining(" "));
        return new PlainStringScalar(plain, above, inline);
    }

    @Override
    public Scalar buildFoldedBlockScalar(final String comment) {
        return new BuiltFoldedBlockScalar(this.lines, comment);
    }

    @Override
    public Scalar buildLiteralBlockScalar(final String comment) {
        return new BuiltLiteralBlockScalar(this.lines, comment);
    }

    /**
     * A built folded block Scalar.
     * @author Mihai Andronache ([email protected])
     * @version $Id: 6b04a6743c9ee5ee8d96674b6a9376573fd907bb $
     * @since 4.0.0
     */
    static class BuiltFoldedBlockScalar extends BaseFoldedScalar {

        /**
         * Comments referring to this scalar.
         */
        private final Comment comment;

        /**
         * Lines of this scalar.
         */
        private final List lines;

        /**
         * Ctor.
         * @param lines Given string lines.
         */
        BuiltFoldedBlockScalar(final List lines) {
            this(lines, "");
        }

        /**
         * Ctor.
         * @param comment Comment referring to this scalar.
         * @param lines Given string lines.
         */
        BuiltFoldedBlockScalar(
            final List lines, final String comment
        ) {
            this.lines = lines;
            this.comment = new BuiltComment(this, comment);
        }

        /**
         * Return the value of this folded block scalar.
         * @todo #244:30min This method is not correct. When returning
         *  the value we should indeed fold the new lines, with the exception
         *  that we should preserve the blank lines and new lines of more inner
         *  indented lines. See how ReadFoldedBlockScalar.value()
         *  is implemented.
         * @return String value.
         */
        @Override
        public String value() {
            return this.lines.stream().map(
                line -> line.replaceAll(System.lineSeparator(), " ")
            ).collect(Collectors.joining(" "));
        }

        @Override
        public Comment comment() {
            return this.comment;
        }

        @Override
        final List unfolded() {
            final List unfolded = new ArrayList<>();
            unfolded.addAll(this.lines);
            return unfolded;
        }
    }

    /**
     * A built literal block Scalar.
     * @author Mihai Andronache ([email protected])
     * @version $Id: 6b04a6743c9ee5ee8d96674b6a9376573fd907bb $
     * @since 4.0.0
     */
    static class BuiltLiteralBlockScalar extends BaseScalar {

        /**
         * Comments referring to this scalar.
         */
        private final Comment comment;

        /**
         * Lines of this scalar.
         */
        private final List lines;

        /**
         * Ctor.
         * @param lines Given string lines.
         */
        BuiltLiteralBlockScalar(final List lines) {
            this(lines, "");
        }

        /**
         * Ctor.
         * @param lines Given string lines.
         * @param comment Comment referring to this scalar.
         */
        BuiltLiteralBlockScalar(
            final List lines, final String comment
        ) {
            this.lines = lines;
            this.comment = new BuiltComment(this, comment);
        }


        /**
         * Return the value of this literal scalar.
         * @return String value.
         */
        @Override
        public String value() {
            return this.lines.stream().collect(
                Collectors.joining(System.lineSeparator())
            );
        }

        @Override
        public Comment comment() {
            return this.comment;
        }
    }
}