com.amihaiemil.eoyaml.ReadComment 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;

/**
 * A comment which has been read from somewhere.
 * @author Mihai Andronache ([email protected])
 * @version $Id: 4607234231f020853505837b1200fa70ee0799ff $
 * @since  4.2.0
 */
final class ReadComment implements Comment {

    /**
     * Node to which this comment refers.
     */
    private final YamlNode node;

    /**
     * Calculated comment.
     */
    private final String comment;


    /**
     * Constructor.
     * @param lines Lines of this comment.
     * @param node Node to which it refers.
     */
    ReadComment(final YamlLines lines, final YamlNode node) {
        this.node = node;
        this.comment = calculateComments(lines).toString().trim();
    }

    @Override
    public YamlNode yamlNode() {
        return this.node;
    }

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

    /**
     * Pre-compute the comment value.
     *
     * @param lines The lines to parse into comments.
     * @return Comments.
     */
    private StringBuilder calculateComments(final YamlLines lines) {
        final StringBuilder tmpComment = new StringBuilder();
        for(final YamlLine line : lines) {
            tmpComment
                    .append(line.comment().trim())
                    .append(System.lineSeparator());
        }
        return tmpComment;
    }
}