All Classes and Interfaces
Class
Description
Because recursive structures are not very common we provide a way to save some typing when
extending a constructor
Marks the inclusion of a previously anchored node.
Alias
Support different anchors
This class is only used during representation (dumping)
Anchor
Custom stack
Array manipulation
Base code
Represent basic YAML structures: scalar, sequence, mapping
Control instance variables.
Block end
block entry
BlockMappingStartToken
BlockSequenceStartToken
Base class for the end events of the collection nodes.
Base class for the two collection types
mapping and collection.Base class for the start events of the collection nodes.
Marks a comment block value.
Used by the Composer and Emitter to collect comment events so that they can be used at a later
point in the process.
A comment line.
Comment for humans
The type of comment line.
Construct a custom Java instance out of a compact object notation format.
Custom data structure to support compact notation
https://bitbucket.org/snakeyaml/snakeyaml/wiki/CompactObjectNotation
Creates a node graph from parser events.
Exception during compose phase
Keep constants
Provide a way to construct a Java instance out of the composed Node.
Construct a custom Java instance.
Exception during object construction
Construct instances with a custom Class Loader.
Token
Marks the end of a document.
DocumentEndToken
Marks the beginning of a document.
DocumentStartToken
Configuration for serialisation
Block styles use indentation to denote nesting and scope within the document.
Platform dependent line break.
the way to serialize non-printable
YAML provides a rich set of scalar styles.
Specification version.
Indicate mapping with the same key
Drefine a way to serialize an event to output stream
Emitter expects events obeying the following grammar:
stream ::= STREAM-START document* STREAM-END
document ::= DOCUMENT-START node DOCUMENT-END
node ::= SCALAR | sequence | mapping
sequence ::= SEQUENCE-START node* SEQUENCE-END
mapping ::= MAPPING-START (node node)* MAPPING-END
For emitter
Helper
Construct scalar for format ${VARIABLE} replacing the template with the value from environment.
Event types
A
FieldProperty is a Property which is accessed as a field, without
going through accessor methods (setX, getX).FlowEntryToken
FlowMappingEndToken
FlowMappingStartToken
FlowSequenceEndToken
FlowSequenceStartToken
Shared code for all the properties
The implicit flag of a scalar event is a pair of boolean values that indicate if the tag may be
omitted when the scalar is emitted in a plain and non-plain style correspondingly.
Key
Configuration for loading
Marks the end of a mapping node.
Represents a map.
Marks the beginning of a mapping node.
It's just a record and its only use is producing nice error messages.
A
MethodProperty is a Property which is accessed through accessor
methods (setX, getX).Indicate missing mandatory environment variable in the template Used by EnvScalarConstructor
A property that does not map to a real property; this is used when
PropertyUtils.setSkipMissingProperties(boolean) is set to true.Base class for all nodes.
Base class for all events that mark the beginning of a node.
Enum for the basic YAML types: scalar, sequence, mapping or anchor.
Stores one key value pair used in a map.
This interface represents an input stream of
Events.Exception thrown by the
Parser implementations in case of malformed input.
# The following YAML grammar is LL(1) and is parsed by a recursive descent
parser.
A
Property represents a single member variable of a class, possibly including its
accessor methods (getX, setX).Create a Node Graph out of the provided Native Data Structure (Java instance).
Represent JavaBeans
Resolver tries to detect a type by content (when the tag is implicit)
Construct standard Java classes
Accumulate information to choose the scalar style
Marks a scalar value.
Represents a scalar node.
This interface represents an input stream of
Tokens.Exception thrown by the
Scanner implementations in case of malformed input.
Scanner produces tokens of the following types:
STREAM-START
STREAM-END
COMMENT
DIRECTIVE(name, value)
DOCUMENT-START
DOCUMENT-END
BLOCK-SEQUENCE-START
BLOCK-MAPPING-START
BLOCK-END
FLOW-SEQUENCE-START
FLOW-MAPPING-START
FLOW-SEQUENCE-END
FLOW-MAPPING-END
BLOCK-ENTRY
FLOW-ENTRY
KEY
VALUE
ALIAS(value)
ANCHOR(value)
TAG(value)
SCALAR(value, plain, style)
Read comments in the Scanner code for more details.
Marks the end of a sequence.
Represents a sequence.
Marks the beginning of a sequence node.
Marks the end of a stream that might have contained multiple documents.
Reader: checks if code points are in allowed range.
Marks the start of a stream that might contain multiple documents.
Provides additional runtime information necessary to create a custom Java instance.
Generic unicode textreader, which will use BOM mark to identify the encoding to be used.
Public YAML interface.