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

Go to download
/**
 * 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.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeParseException;
import java.util.Collection;
import java.util.Iterator;

/**
 * A Yaml sequence.
 * @checkstyle ReturnCount (400 lines)
 * @author Mihai Andronache ([email protected])
 * @version $Id: 8486ad876fd5a773180de2622461dfec5a256e57 $
 * @since 1.0.0
 */
public interface YamlSequence extends YamlNode, Iterable {

    /**
     * The number of Yaml elements (scalars, mappings and sequences) found in
     * this sequence.
     * @return Integer.
     */
    int size();

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

    /**
     * Get the Yaml mapping  from the given index.
     * @param index Integer index.
     * @return Yaml mapping.
     */
    YamlMapping yamlMapping(final int index);

    /**
     * Get the Yaml sequence from the given index.
     * @param index Integer index.
     * @return Yaml sequence.
     */
    YamlSequence yamlSequence(final int index);

    /**
     * Get the String from the given index.
     * @param index Integer index.
     * @return String.
     */
    String string(final int index);

    /**
     * Get the folded block scalar from the given index.
     * @param index Integer index.
     * @return The folded block scalar as String.
     */
    String foldedBlockScalar(final int index);

    /**
     * Get the literal block scalar from the given index.
     * @param index Integer index.
     * @return The folded block scalar as String.
     */
    Collection literalBlockScalar(final int index);

    /**
     * Returns this YamlSequence's children Iterator.


     * It is equivalent to YamlSequence.values().iterator().
     * @return Iterator of YamlNode.
     */
    Iterator iterator();

    /**
     * Convenience method to directly read an integer value
     * from this sequence. It is equivalent to:
     *      *     YamlSequence sequence = ...;
     *     int value = Integer.parseInt(sequence.string(...));
     * 
     * @param index The index of the value.
     * @return Found integer.
     * @throws NumberFormatException - if the Scalar value
     *  is not a parsable integer.
     */
    default int integer(final int index) {
        final String value = this.string(index);
        if(value != null && !value.isEmpty()) {
            return Integer.parseInt(value);
        }
        return -1;
    }

    /**
     * Convenience method to directly read a float value
     * from this sequence. It is equivalent to:
     *      *     YamlSequence sequence = ...;
     *     float value = Float.parseFloat(sequence.string(...));
     * 
     * @param index The index of the value.
     * @return Found float.
     * @throws NumberFormatException - if the Scalar value
     *  is not a parsable float.
     */
    default float floatNumber(final int index) {
        final String value = this.string(index);
        if(value != null && !value.isEmpty()) {
            return Float.parseFloat(value);
        }
        return -1;
    }

    /**
     * Convenience method to directly read a double value
     * from this sequence. It is equivalent to:
     *      *     YamlSequence sequence = ...;
     *     double value = Double.parseDouble(sequence.string(...));
     * 
     * @param index The index of the value.
     * @return Found double.
     * @throws NumberFormatException - if the Scalar value
     *  is not a parsable double.
     */
    default double doubleNumber(final int index) {
        final String value = this.string(index);
        if(value != null && !value.isEmpty()) {
            return Double.parseDouble(value);
        }
        return -1.0;
    }

    /**
     * Convenience method to directly read a long value
     * from this sequence. It is equivalent to:
     *      *     YamlSequence sequence = ...;
     *     long value = Long.parseLong(sequence.string(...));
     * 
     * @param index The index of the value.
     * @return Found long.
     * @throws NumberFormatException - if the Scalar value
     *  is not a parsable long.
     */
    default long longNumber(final int index) {
        final String value = this.string(index);
        if(value != null && !value.isEmpty()) {
            return Long.parseLong(value);
        }
        return -1L;
    }

    /**
     * Convenience method to directly read a LocalDate value
     * from this sequence. It is equivalent to:
     *      *     YamlSequence sequence = ...;
     *     LocalDate dateTime = LocalDate.parse(sequence.string(...));
     * 
     * @param index The index of the value.
     * @return Found LocalDate.
     * @throws DateTimeParseException - if the Scalar value cannot be parsed.
     */
    default LocalDate date(final int index) {
        final String value = this.string(index);
        if(value != null && !value.isEmpty()) {
            return LocalDate.parse(value);
        }
        return null;
    }

    /**
     * Convenience method to directly read a LocalDateTime value
     * from this sequence. It is equivalent to:
     *      *     YamlSequence sequence = ...;
     *     LocalDateTime dateTime = LocalDateTime.parse(sequence.string(...));
     * 
     * @param index The index of the value.
     * @return Found LocalDateTime.
     * @throws DateTimeParseException - if the Scalar value cannot be parsed.
     */
    default LocalDateTime dateTime(final int index) {
        final String value = this.string(index);
        if(value != null && !value.isEmpty()) {
            return LocalDateTime.parse(value);
        }
        return null;
    }
}