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

/**
 * Decorator for a {@link YamlSequence} which throws YamlNodeNotFoundException
 * if any of the methods of the decorated YamlSequence returns null
 * (if the given index points to a YamlNode that is not a YamlMapping,
 * for instance).
 * @deprecated This class will be moved to the extensions package in one
 *  of the future releases. There will be no changes to it other than a
 *  more suitable package.
 * @author Salavat.Yalalov ([email protected])
 * @version $Id: adfebbf780d0adee44f67ebe4bdabce3e6e505e8 $
 * @since 1.0.0
 */
@Deprecated
public final class StrictYamlSequence extends BaseYamlSequence {

    /**
     * Original YamlSequence.
     */
    private YamlSequence decorated;

    /**
     * Ctor.
     * @param decorated Original YamlSequence
     */
    public StrictYamlSequence(final YamlSequence decorated) {
        this.decorated = decorated;
    }

    @Override
    public Collection values() {
        return this.decorated.values();
    }

    /**
     * Get the Yaml mapping  from the given index.
     * @param index Integer index.
     * @return Yaml mapping
     */
    @Override
    public YamlMapping yamlMapping(final int index) {
        YamlMapping found = this.decorated.yamlMapping(index);
        if (found == null) {
            throw new YamlNodeNotFoundException(
                "No YamlMapping found at index " + index
            );
        }
        return found;
    }

    /**
     * Get the Yaml sequence  from the given index.
     * @param index Integer index.
     * @return Yaml sequence
     */
    @Override
    public YamlSequence yamlSequence(final int index) {
        YamlSequence found = this.decorated.yamlSequence(index);
        if (found == null) {
            throw new YamlNodeNotFoundException(
                "No YamlSequence found at index " + index
            );
        }
        return found;
    }

    /**
     * Get the String from the given index.
     * @param index Integer index.
     * @return String
     */
    @Override
    public String string(final int index) {
        String found = this.decorated.string(index);
        if (found == null) {
            throw new YamlNodeNotFoundException(
                "No String found at index " + index
            );
        }
        return found;
    }

    /**
     * Get the folded block String from the given index.
     * @param index Integer index.
     * @return String
     */
    @Override
    public String foldedBlockScalar(final int index) {
        String found = this.decorated.foldedBlockScalar(index);
        if (found == null) {
            throw new YamlNodeNotFoundException(
                "No folded block scalar found at index " + index
            );
        }
        return found;
    }

    /**
     * Get the literal block Strings from the given index.
     * @param index Integer index.
     * @return Collection of String lines of the literal.
     */
    @Override
    public Collection literalBlockScalar(final int index) {
        Collection found = this.decorated.literalBlockScalar(index);
        if (found == null) {
            throw new YamlNodeNotFoundException(
                "No String found at index " + index
            );
        }
        return found;
    }

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