org.snakeyaml.engine.v2.nodes.Node Maven / Gradle / Ivy
Show all versions of snakeyaml-engine Show documentation
/*
* Copyright (c) 2018, SnakeYAML
*
* 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
*
* http://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.snakeyaml.engine.v2.nodes;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import org.snakeyaml.engine.v2.comments.CommentLine;
import org.snakeyaml.engine.v2.common.Anchor;
import org.snakeyaml.engine.v2.exceptions.Mark;
/**
* Base class for all nodes.
*
* The nodes form the node-graph described in the YAML
* Specification.
*
*
* While loading, the node graph is usually created by the
* {@link org.snakeyaml.engine.v2.composer.Composer}.
*
*/
public abstract class Node {
private final Optional startMark;
protected Optional endMark;
/**
* true when the tag is assigned by the resolver
*/
protected boolean resolved;
private Tag tag;
private boolean recursive;
private Optional anchor;
private List inLineComments;
private List blockComments;
// End Comments are only on the last node in a document
private List endComments;
private Map properties;
/**
* Create Node to be parsed
*
* @param tag - the tag
* @param startMark - start mark when available
* @param endMark - end mark when available
*/
public Node(Tag tag, Optional startMark, Optional endMark) {
setTag(tag);
this.startMark = startMark;
this.endMark = endMark;
this.recursive = false;
this.resolved = true;
this.anchor = Optional.empty();
this.inLineComments = null;
this.blockComments = null;
this.endComments = null;
this.properties = null;
}
/**
* Tag of this node.
*
* Every node has a tag assigned. The tag is either local or global.
*
* @return Tag of this node.
*/
public Tag getTag() {
return this.tag;
}
public void setTag(Tag tag) {
Objects.requireNonNull(tag, "tag in a Node is required.");
this.tag = tag;
}
public Optional getEndMark() {
return endMark;
}
/**
* @return scalar, sequence, mapping
*/
public abstract NodeType getNodeType();
public Optional getStartMark() {
return startMark;
}
/**
* Node is only equal to itself
*/
@Override
public final boolean equals(Object obj) {
return super.equals(obj);
}
/**
* Indicates if this node must be constructed in two steps.
*
* Two-step construction is required whenever a node is a child (direct or indirect) of it self.
* That is, if a recursive structure is build using anchors and aliases.
*
*
* Set by {@link org.snakeyaml.engine.v2.composer.Composer}, used during the construction process.
*
*
* Only relevant during loading.
*
*
* @return true if the node is self referenced.
*/
public boolean isRecursive() {
return recursive;
}
public void setRecursive(boolean recursive) {
this.recursive = recursive;
}
@Override
public final int hashCode() {
return super.hashCode();
}
/**
* Get the anchor if it was defined for this Node
*
* @return the Anchor if available
* @see 3.2.2.2. Anchors and Aliases
*/
public Optional getAnchor() {
return anchor;
}
/**
* Set the anchor for this Node
*
* @param anchor - the Anchor for this Node
* @see 3.2.2.2. Anchors and Aliases
*/
public void setAnchor(Optional anchor) {
this.anchor = anchor;
}
/**
* Define a custom runtime property. It is not used by Engine but may be used by other tools.
*
* @param key - the key for the custom property
* @param value - the value for the custom property
* @return the previous value for the provided key if it was defined
*/
public Object setProperty(String key, Object value) {
if (properties == null) {
properties = new HashMap<>();
}
return properties.put(key, value);
}
/**
* Get the custom runtime property.
*
* @param key - the key of the runtime property
* @return the value if it was specified
*/
public Object getProperty(String key) {
if (properties == null) {
return null;
} else {
return properties.get(key);
}
}
/**
* The ordered list of in-line comments. The first of which appears at the end of the line
* respresent by this node. The rest are in the following lines, indented per the Spec to indicate
* they are continuation of the inline comment.
*
* @return the comment line list.
*/
public List getInLineComments() {
return inLineComments;
}
public void setInLineComments(List inLineComments) {
this.inLineComments = inLineComments;
}
/**
* The ordered list of blank lines and block comments (full line) that appear before this node.
*
* @return the comment line list.
*/
public List getBlockComments() {
return blockComments;
}
public void setBlockComments(List blockComments) {
this.blockComments = blockComments;
}
/**
* The ordered list of blank lines and block comments (full line) that appear AFTER this node.
*
* NOTE: these comment should occur only in the last node in a document, when walking the node
* tree "in order"
*
* @return the comment line list.
*/
public List getEndComments() {
return endComments;
}
public void setEndComments(List endComments) {
this.endComments = endComments;
}
}