com.amihaiemil.eoyaml.YamlSequence 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
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 javax.json.JsonArray;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeParseException;
import java.util.*;
/**
* A Yaml sequence.
* @checkstyle ReturnCount (400 lines)
* @author Mihai Andronache ([email protected])
* @version $Id: 783c0e06529936a751f286a44257e08a692f9d6a $
* @since 1.0.0
*/
public interface YamlSequence extends YamlNode, Iterable {
/**
* Fetch the values of this sequence.
* @return Collection of {@link YamlNode}
*/
Collection values();
@Override
default List children() {
return new ArrayList<>(this.values());
}
/**
* Returns this YamlSequence's children Iterator.
* It is equivalent to YamlSequence.values().iterator().
* @return Iterator of YamlNode.
*/
default Iterator iterator() {
return this.values().iterator();
}
/**
* The number of Yaml elements (scalars, mappings and sequences) found in
* this sequence.
* @return Integer.
*/
default int size() {
return this.values().size();
}
/**
* Get the Yaml node at the given index position.
* @param index Integer index.
* @return The Yaml node at index, or null if index is out of bounds.
*/
default YamlNode yamlNode(final int index) {
YamlNode result = null;
int count = 0;
for (final YamlNode node : this.values()) {
if (count == index) {
result = node;
break;
}
count++;
}
return result;
}
/**
* Get the Yaml mapping from the given index.
* @param index Integer index.
* @return The Yaml mapping at index, or null if the node is not a Yaml
* mapping
*/
default YamlMapping yamlMapping(final int index) {
YamlMapping mapping = null;
YamlNode node = this.yamlNode(index);
if (node instanceof YamlMapping) {
mapping = (YamlMapping) node;
}
return mapping;
}
/**
* Get the Yaml sequence from the given index.
* @param index Integer index.
* @return The Yaml sequence at index, or null if the node is not a Yaml
* sequence
*/
default YamlSequence yamlSequence(final int index) {
YamlSequence sequence = null;
YamlNode node = this.yamlNode(index);
if (node instanceof YamlSequence) {
sequence = (YamlSequence) node;
}
return sequence;
}
/**
* Get the String from the given index.
* @param index Integer index.
* @return The String at index, or null if the node is not a string.
*/
default String string(final int index) {
String string = null;
YamlNode node = this.yamlNode(index);
if (node instanceof Scalar) {
string = ((Scalar) node).value();
}
return string;
}
/**
* Get the folded block scalar from the given index.
* @param index Integer index.
* @return The folded block scalar as a single String, or null if the node
* is not a scalar.
*/
default String foldedBlockScalar(final int index) {
return this.string(index);
}
/**
* Get the literal block scalar from the given index.
* @param index Integer index.
* @return The folded block scalar as a list of Strings, or null if the
* node is not a scalar.
*/
default Collection literalBlockScalar(final int index) {
Collection lines = null;
String nodetext = this.string(index);
if (nodetext != null) {
lines = Arrays.asList(nodetext.split(System.lineSeparator()));
}
return lines;
}
/**
* 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 The found integer.
* @throws NumberFormatException - if the node is not a parsable integer.
*/
default int integer(final int index) {
final String value = this.string(index);
if(value == null || value.isEmpty()) {
throw new NumberFormatException();
}
return Integer.parseInt(value);
}
/**
* 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 node is not a parsable float.
*/
default float floatNumber(final int index) {
final String value = this.string(index);
if(value == null || value.isEmpty()) {
throw new NumberFormatException();
}
return Float.parseFloat(value);
}
/**
* 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 node is not a parsable double.
*/
default double doubleNumber(final int index) {
final String value = this.string(index);
if(value == null || value.isEmpty()) {
throw new NumberFormatException();
}
return Double.parseDouble(value);
}
/**
* 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 node is not a parsable long.
*/
default long longNumber(final int index) {
final String value = this.string(index);
if(value == null || value.isEmpty()) {
throw new NumberFormatException();
}
return Long.parseLong(value);
}
/**
* 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, or null if index out of bounds or no scalar at
* index.
* @throws DateTimeParseException - if the Scalar value cannot be parsed.
*/
default LocalDate date(final int index) {
LocalDate date = null;
final String value = this.string(index);
if(value != null && !value.isEmpty()) {
date = LocalDate.parse(value);
}
return date;
}
/**
* 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, or null if index out of bounds or no
* scalar at index.
* @throws DateTimeParseException - if the Scalar value cannot be parsed.
*/
default LocalDateTime dateTime(final int index) {
LocalDateTime datetime = null;
final String value = this.string(index);
if(value != null && !value.isEmpty()) {
datetime = LocalDateTime.parse(value);
}
return datetime;
}
/**
* Convenience method to directly read a boolean value
* from this sequence. Returns true if the value is not null and is equal,
* ignoring case, to the string "true".It is equivalent to:
*
* YamlSequence sequence = ...;
* boolean value = Boolean.parseBoolean(sequence.string(...));
*
* @param index The index of the value.
* @return Boolean.
*/
default boolean bool(final int index) {
return Boolean.parseBoolean(this.string(index));
}
/**
* Turn this YamlSequence to a JsonArray.
* @return JsonArray.
*/
default JsonArray toJsonArray() {
return (JsonArray) this.accept(new YamlToJsonVisitor());
}
}