org.openrewrite.yaml.tree.Yaml Maven / Gradle / Ivy
Show all versions of rewrite-yaml Show documentation
/*
* Copyright 2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.yaml.tree;
import lombok.*;
import lombok.experimental.FieldDefaults;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
import org.openrewrite.marker.Markers;
import org.openrewrite.yaml.YamlVisitor;
import org.openrewrite.yaml.internal.YamlPrinter;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.util.List;
import java.util.UUID;
import static java.util.stream.Collectors.toList;
import static org.openrewrite.Tree.randomId;
public interface Yaml extends Tree {
@SuppressWarnings("unchecked")
@Override
default R accept(TreeVisitor v, P p) {
return (R) acceptYaml(v.adapt(YamlVisitor.class), p);
}
@Override
default boolean isAcceptable(TreeVisitor v, P p) {
return v.isAdaptableTo(YamlVisitor.class);
}
default
@Nullable Yaml acceptYaml(YamlVisitor
v, P p) {
return v.defaultValue(this, p);
}
/**
* @return A new deep copy of this block with different IDs.
*/
Yaml copyPaste();
String getPrefix();
Yaml withPrefix(String prefix);
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
class Documents implements Yaml, SourceFile {
@EqualsAndHashCode.Include
UUID id;
Markers markers;
Path sourcePath;
@Nullable
FileAttributes fileAttributes;
@Nullable // for backwards compatibility
@With(AccessLevel.PRIVATE)
String charsetName;
boolean charsetBomMarked;
@Nullable
Checksum checksum;
@Override
public Charset getCharset() {
return charsetName == null ? StandardCharsets.UTF_8 : Charset.forName(charsetName);
}
@Override
public SourceFile withCharset(Charset charset) {
return withCharsetName(charset.name());
}
List documents;
@Override
public Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitDocuments(this, p);
}
@Override
public Documents copyPaste() {
return new Documents(randomId(), Markers.EMPTY,
sourcePath, fileAttributes, charsetName, charsetBomMarked, checksum, documents.stream().map(Document::copyPaste).collect(toList()));
}
/**
* Prefixes will always be on {@link Mapping.Entry}.
*
* @return The empty string.
*/
@Override
public String getPrefix() {
return "";
}
@Override
public Documents withPrefix(String prefix) {
if (!prefix.isEmpty()) {
throw new UnsupportedOperationException("Yaml.Documents may not have a non-empty prefix");
}
return this;
}
@Override
public
TreeVisitor> printer(Cursor cursor) {
return new YamlPrinter<>();
}
}
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
class Document implements Yaml {
@EqualsAndHashCode.Include
UUID id;
String prefix;
Markers markers;
boolean explicit;
Block block;
End end;
@Override
public
Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitDocument(this, p);
}
@Override
public Document copyPaste() {
return new Document(
randomId(),
prefix,
Markers.EMPTY,
explicit,
block.copyPaste(),
end == null ? null : end.copyPaste()
);
}
/**
* Document end specification.
*/
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
public static class End implements Yaml {
@EqualsAndHashCode.Include
UUID id;
String prefix;
Markers markers;
/**
* Yaml documents may be explicitly ended with "..."
* When this is set to "true" the "..." will be printed out.
* When this is set to "false" no "..." will be printed, but a comment at the end of the document still will be
* @see YAML specification
*/
boolean explicit;
@Override
public
Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitDocumentEnd(this, p);
}
@Override
public End copyPaste() {
return new End(randomId(), prefix, Markers.EMPTY, explicit);
}
}
}
interface Block extends Yaml {
/**
* @return A new deep copy of this block with different IDs.
*/
@Override
Block copyPaste();
@Override
Block withPrefix(String prefix);
}
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
class Scalar implements Block, YamlKey {
@EqualsAndHashCode.Include
UUID id;
String prefix;
Markers markers;
Style style;
@Nullable
Anchor anchor;
String value;
public enum Style {
DOUBLE_QUOTED,
SINGLE_QUOTED,
LITERAL,
FOLDED,
PLAIN
}
@Override
public
Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitScalar(this, p);
}
@Override
public Scalar copyPaste() {
return new Scalar(randomId(), prefix, Markers.EMPTY, style, anchor, value);
}
@Override
public String toString() {
return "Yaml.Scalar(" + value + ")";
}
}
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@Data
@With
class Mapping implements Block {
@EqualsAndHashCode.Include
UUID id;
Markers markers;
@Nullable
String openingBracePrefix;
List entries;
@Nullable
String closingBracePrefix;
@Nullable
Anchor anchor;
@Override
public Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitMapping(this, p);
}
@Override
public Mapping copyPaste() {
return new Mapping(randomId(), Markers.EMPTY, openingBracePrefix, entries.stream().map(Entry::copyPaste)
.collect(toList()), closingBracePrefix, anchor);
}
/**
* Prefixes will always be on {@link Entry}.
*
* @return The empty string.
*/
@Override
public String getPrefix() {
return "";
}
@Override
public Mapping withPrefix(String prefix) {
if (!prefix.isEmpty()) {
throw new UnsupportedOperationException("Yaml.Mapping may not have a non-empty prefix");
}
return this;
}
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
public static class Entry implements Yaml {
@EqualsAndHashCode.Include
UUID id;
String prefix;
Markers markers;
YamlKey key;
// https://yaml.org/spec/1.2/spec.html#:%20mapping%20value//
String beforeMappingValueIndicator;
Block value;
@Override
public
Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitMappingEntry(this, p);
}
@Override
public Entry copyPaste() {
return new Entry(randomId(), prefix, Markers.EMPTY, key.copyPaste(),
beforeMappingValueIndicator, value.copyPaste());
}
}
}
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@Data
@With
class Sequence implements Block {
@EqualsAndHashCode.Include
UUID id;
Markers markers;
/**
* Will contain the whitespace preceding the '[' in an inline sequence like [a, b].
* Will be null if the sequence is not an inline sequence, e.g.:
* - foo
* - bar
*/
@Nullable
String openingBracketPrefix;
List entries;
@Nullable
String closingBracketPrefix;
@Nullable
Anchor anchor;
@Override
public Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitSequence(this, p);
}
@Override
public Sequence copyPaste() {
return new Sequence(randomId(), Markers.EMPTY, openingBracketPrefix,
entries.stream().map(Entry::copyPaste).collect(toList()), closingBracketPrefix, anchor);
}
@Override
public String getPrefix() {
return "";
}
@Override
public Sequence withPrefix(String prefix) {
if (!prefix.isEmpty()) {
throw new UnsupportedOperationException("Yaml.Sequence may not have a non-empty prefix");
}
return this;
}
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
public static class Entry implements Yaml {
@EqualsAndHashCode.Include
UUID id;
@With
String prefix;
@With
Markers markers;
@With
Block block;
/**
* Set to true when this entry is part of a sequence like:
* - 1
* - 2
*
* And false when this entry is part of a sequence like:
* [1, 2]
*/
boolean dash;
/**
* Holds the whitespace between this entry and its trailing comma, if any.
* v
* [1 , 2]
* null if there is no trailing comma.
*/
@Nullable
@With
String trailingCommaPrefix;
@Override
public
Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitSequenceEntry(this, p);
}
@Override
public Entry copyPaste() {
return new Entry(randomId(), prefix, Markers.EMPTY,
block.copyPaste(), dash, trailingCommaPrefix);
}
}
}
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
class Alias implements Block, YamlKey {
@EqualsAndHashCode.Include
UUID id;
@With
String prefix;
@With
Markers markers;
@With
Anchor anchor;
@Override
public
Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitAlias(this, p);
}
@Override
public String getValue() {
return anchor.key;
}
@Override
public Alias copyPaste() {
return new Alias(randomId(), prefix, Markers.EMPTY, anchor);
}
@Override
public String toString() {
return "Yaml.Alias(" + anchor + ")";
}
}
@Value
@EqualsAndHashCode(callSuper = false, onlyExplicitlyIncluded = true)
@With
class Anchor implements Yaml {
@EqualsAndHashCode.Include
UUID id;
@With
String prefix;
@With
String postfix;
@With
Markers markers;
@With
String key;
@Override
public
Yaml acceptYaml(YamlVisitor
v, P p) {
return v.visitAnchor(this, p);
}
@Override
public Anchor copyPaste() {
return new Anchor(randomId(), prefix, postfix, Markers.EMPTY, key);
}
@Override
public String toString() {
return "Yaml.Anchor(" + key + ")";
}
}
}