com.amihaiemil.eoyaml.YamlLine 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 com.amihaiemil.eoyaml.exceptions.YamlReadingException;
/**
* A line of yaml.
* @author Mihai Andronache ([email protected])
* @version $Id: 331b116e49a9757a605310d248839e7049fcb677 $
* @since 1.0.0
*/
interface YamlLine extends Comparable {
/**
* Indicates we don't know or don't have a line number for the given
* comment (may not have come from a file).
*/
int UNKNOWN_LINE_NUMBER = -1;
/**
* The line's value, untrimmed, containing comments etc.
* @return String.
*/
String value();
/**
* The line's trimmed contents with comments, aliases etc removed.
* @return Trimmed string (leading and trailing spaces) contents.
* @todo #374:60min There's a missing condition in this method, removed
* as a workaround in Pull Request 375. Debug, find the reason and
* implement a better solution for ticket 374. This is rather low prio.
* @checkstyle CyclomaticComplexity (100 lines)
*/
default String trimmed() {
String trimmed = this.value().trim();
int i = 0;
while(i < trimmed.length()) {
if(i > 0 && trimmed.charAt(i) == '#') {
if(trimmed.charAt(i - 1) == ' ') {
trimmed = trimmed.substring(0, i);
break;
}
} else if(trimmed.charAt(i) == '"') {
i++;
while(i < trimmed.length() && trimmed.charAt(i) != '"') {
i++;
}
} else if(trimmed.charAt(i) == '\'') {
i++;
while(i < trimmed.length() && trimmed.charAt(i) != '\'') {
i++;
}
}
i++;
}
return trimmed.trim();
}
/**
* The line's contents with spaces, tabs, etc maintained.
* @param previousIndent How deeply nested is the Yaml line - this is used
* to remove leading spaces.
* @return String line contents.
*/
default String contents(final int previousIndent) {
String contents;
int indentation = indentation();
if (indentation == 0 && previousIndent <= 0) {
contents = this.value();
} else if (indentation > previousIndent) {
contents = this.value().substring(previousIndent + 2);
} else {
throw new YamlReadingException("Literal must be indented "
+ "at least 2 spaces from previous element.");
}
return contents;
}
/**
* Return the comment, if any, from this line.
* @return Comment of empty string.
*/
default String comment() {
String comment = "";
String trimmed = this.value().trim();
int i = 0;
while(i < trimmed.length()) {
if(trimmed.charAt(i) == '#') {
comment = trimmed.substring(i + 1);
break;
} else if(trimmed.charAt(i) == '"') {
i++;
while(i < trimmed.length() && trimmed.charAt(i) != '"') {
i++;
}
} else if(trimmed.charAt(i) == '\'') {
i++;
while(i < trimmed.length() && trimmed.charAt(i) != '\'') {
i++;
}
}
i++;
}
return comment.trim();
}
/**
* Number of the line (count start from 0).
* @return Integer.
*/
int number();
/**
* This line's indentation (number of spaces at the beginning of it).>br>
* Should be a multiple of 2! If not, IllegalStateException is thrown.
* @return Integer.
* @throws IllegalStateException if the indentation is not multiple of 2.
*/
int indentation();
/**
* Do the following line(s) require a deeper indentation than this line's?
* @return True or false
*/
default boolean requireNestedIndentation() {
final boolean result;
if("---".equals(this.trimmed())) {
result = false;
} else {
final String trimmed = this.trimmed();
final CharSequence prevLineLastChar = trimmed.substring(
trimmed.length() - 1
);
if(prevLineLastChar.charAt(0) == '?' && trimmed.length() == 1) {
result = true;
} else {
final String otherSpecialChars = "-";
result = otherSpecialChars.contains(prevLineLastChar);
}
}
return result;
}
/**
* Compare this line to another.
* @param other Other line to compare.
* @return Zero if same line object, 1 if other is null, or string
* comparison of the trimmed (no spaces or comments) values.
*/
default int compareTo(final YamlLine other) {
int result = -1;
if (this == other) {
result = 0;
} else if (other == null) {
result = 1;
} else {
result = this.trimmed().compareTo(other.trimmed());
}
return result;
}
/**
* YamlLine null object.
*/
class NullYamlLine implements YamlLine {
@Override
public String value() {
return "";
}
@Override
public String trimmed() {
return "";
}
@Override
public String contents(final int previousIndent) {
return "";
}
@Override
public int number() {
return UNKNOWN_LINE_NUMBER;
}
@Override
public int indentation() {
return -1;
}
}
}