Skip navigation links
A B C D E F G H I J L M N O P R S T U V W Y 

A

addClassTag(Class<? extends Object>, Tag) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter
Define a tag for the Class to serialize.
addImplicitResolver(Tag, Pattern, String) - Method in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Add a resolver to resolve a value that matches the provided regular expression to the provided tag
addImplicitResolvers() - Method in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Register all the resolvers to be applied
ALPHA - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
Anchor - Class in org.snakeyaml.engine.v2.common
Value inside Anchor and Alias
Anchor(String) - Constructor for class org.snakeyaml.engine.v2.common.Anchor
Create
AnchorGenerator - Interface in org.snakeyaml.engine.v2.serializer
Functional interface to define Anchor for dumping
apply(String, String, String, String) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructEnv
Implement the logic for missing and unset variables
ArrayStack<T> - Class in org.snakeyaml.engine.v2.common
Custom stack
ArrayStack(int) - Constructor for class org.snakeyaml.engine.v2.common.ArrayStack
Create empty stack

B

BaseConstructor - Class in org.snakeyaml.engine.v2.constructor
Base code
BaseConstructor(LoadSettings) - Constructor for class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create
BaseRepresenter - Class in org.snakeyaml.engine.v2.representer
Represent basic YAML structures: scalar, sequence, mapping
BaseRepresenter() - Constructor for class org.snakeyaml.engine.v2.representer.BaseRepresenter
 
BOOL - Static variable in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Boolean as defined in JSON
build() - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Create immutable DumpSettings
build() - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Build immutable LoadSettings
builder() - Static method in class org.snakeyaml.engine.v2.api.DumpSettings
 
builder() - Static method in class org.snakeyaml.engine.v2.api.LoadSettings
Create the builder

C

CharConstants - Class in org.snakeyaml.engine.v2.common
 
checkEvent(Event.ID) - Method in interface org.snakeyaml.engine.v2.parser.Parser
Check if the next event is one of the given type.
checkEvent(Event.ID) - Method in class org.snakeyaml.engine.v2.parser.ParserImpl
Check the ID of the next event.
checkToken(Token.ID...) - Method in interface org.snakeyaml.engine.v2.scanner.Scanner
Check if the next token is one of the given types.
checkToken(Token.ID...) - Method in class org.snakeyaml.engine.v2.scanner.ScannerImpl
Check whether the next token is one of the given types.
classTags - Variable in class org.snakeyaml.engine.v2.representer.StandardRepresenter
Connect classes to their tags
close() - Method in class org.snakeyaml.engine.v2.api.YamlUnicodeReader
 
collectEvents() - Method in class org.snakeyaml.engine.v2.comments.CommentEventsCollector
Collect all events of the expected type (set during construction) starting with the top event on the event source.
collectEvents(Event) - Method in class org.snakeyaml.engine.v2.comments.CommentEventsCollector
Collect all events of the expected type (set during construction) starting with event provided as an argument and continuing with the top event on the event source.
collectEventsAndPoll(Event) - Method in class org.snakeyaml.engine.v2.comments.CommentEventsCollector
Collect all events of the expected type (set during construction) starting with event provided as an argument and continuing with the top event on the event source.
CommentEventsCollector - Class in org.snakeyaml.engine.v2.comments
Used by the Composer and Emitter to collect comment events so that they can be used at a later point in the process.
CommentEventsCollector(Parser, CommentType...) - Constructor for class org.snakeyaml.engine.v2.comments.CommentEventsCollector
Constructor used to collect comment events emitted by a Parser.
CommentEventsCollector(Queue<Event>, CommentType...) - Constructor for class org.snakeyaml.engine.v2.comments.CommentEventsCollector
Constructor used to collect events emitted by the Serializer.
CommentLine - Class in org.snakeyaml.engine.v2.comments
A comment line.
CommentLine(CommentEvent) - Constructor for class org.snakeyaml.engine.v2.comments.CommentLine
Create
CommentLine(Optional<Mark>, Optional<Mark>, String, CommentType) - Constructor for class org.snakeyaml.engine.v2.comments.CommentLine
Create
CommentType - Enum in org.snakeyaml.engine.v2.comments
The type of comment line.
Compose - Class in org.snakeyaml.engine.v2.api.lowlevel
Helper to compose input stream to Node
Compose(LoadSettings) - Constructor for class org.snakeyaml.engine.v2.api.lowlevel.Compose
Create instance with provided LoadSettings
composeAllFromInputStream(InputStream) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Compose
Parse all YAML documents in a stream and produce corresponding representation trees.
composeAllFromReader(Reader) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Compose
Parse all YAML documents in a stream and produce corresponding representation trees.
composeAllFromString(String) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Compose
Parse all YAML documents in a stream and produce corresponding representation trees.
composeInputStream(InputStream) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Compose
Parse a YAML stream and produce Node
composeKeyNode(MappingNode) - Method in class org.snakeyaml.engine.v2.composer.Composer
To be able to override composeNode(node) which is a key
composeMappingChildren(List<NodeTuple>, MappingNode) - Method in class org.snakeyaml.engine.v2.composer.Composer
Add the provided Node to the children as the last child
composeMappingNode(Optional<Anchor>) - Method in class org.snakeyaml.engine.v2.composer.Composer
Create mapping Node
Composer - Class in org.snakeyaml.engine.v2.composer
Creates a node graph from parser events.
Composer(Parser, LoadSettings) - Constructor for class org.snakeyaml.engine.v2.composer.Composer
Deprecated.
use the other constructor with LoadSettings first
Composer(LoadSettings, Parser) - Constructor for class org.snakeyaml.engine.v2.composer.Composer
Create
composeReader(Reader) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Compose
Parse a YAML stream and produce Node
ComposerException - Exception in org.snakeyaml.engine.v2.exceptions
General exception during composition step
ComposerException(String, Optional<Mark>, String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ComposerException
Create
ComposerException(String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ComposerException
Create
composeScalarNode(Optional<Anchor>, List<CommentLine>) - Method in class org.snakeyaml.engine.v2.composer.Composer
Create ScalarNode
composeSequenceNode(Optional<Anchor>) - Method in class org.snakeyaml.engine.v2.composer.Composer
Compose a sequence Node from the input starting with SequenceStartEvent
composeString(String) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Compose
Parse a YAML stream and produce Node
composeValueNode(MappingNode) - Method in class org.snakeyaml.engine.v2.composer.Composer
To be able to override composeNode(node) which is a value
construct(Node) - Method in interface org.snakeyaml.engine.v2.api.ConstructNode
Construct a Java instance with all the properties injected when it is possible.
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Construct complete YAML document.
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructEnv
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructOptionalClass
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructUuidClass
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlBinary
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlBool
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlFloat
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlInt
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlMap
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlNull
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlSeq
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlSet
 
construct(Node) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlStr
 
ConstructEnv() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructEnv
 
constructMapping(MappingNode) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create filled Map from the provided Node
constructMapping2ndStep(MappingNode, Map<Object, Object>) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Fill the mapping with the data from provided node
constructMapping2ndStep(MappingNode, Map<Object, Object>) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor
 
ConstructNode - Interface in org.snakeyaml.engine.v2.api
Provide a way to construct a Java instance from the composed Node.
constructObject(Node) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Construct object from the specified Node.
constructObjectNoCheck(Node) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Construct object from the specified Node.
ConstructOptionalClass() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructOptionalClass
 
ConstructorException - Exception in org.snakeyaml.engine.v2.exceptions
General exception during construction step
ConstructorException(String, Optional<Mark>, String, Optional<Mark>, Throwable) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ConstructorException
Create
ConstructorException(String, Optional<Mark>, String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ConstructorException
Create
constructRecursive(Node, Object) - Method in interface org.snakeyaml.engine.v2.api.ConstructNode
Apply the second step when constructing recursive structures.
constructRecursive(Node, Object) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlMap
 
constructRecursive(Node, Object) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlSeq
 
constructRecursive(Node, Object) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlSet
 
constructScalar(ScalarNode) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create String from the provided scalar node
constructSequence(SequenceNode) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create instance of List
constructSequenceStep2(SequenceNode, Collection<Object>) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Fill the collection with the data from provided node
constructSet(MappingNode) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create instance of Set from mapping node
constructSet2ndStep(MappingNode, Set<Object>) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Fill the Map with the data from the node
constructSet2ndStep(MappingNode, Set<Object>) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor
 
constructSingleDocument(Optional<Node>) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Ensure that the stream contains a single document and construct it
ConstructUuidClass() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructUuidClass
 
ConstructYamlBinary() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlBinary
 
ConstructYamlBool() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlBool
 
ConstructYamlFloat() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlFloat
 
ConstructYamlInt() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlInt
 
ConstructYamlMap() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlMap
 
ConstructYamlNull() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlNull
 
ConstructYamlSeq() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlSeq
 
ConstructYamlSet() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlSet
 
ConstructYamlStr() - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlStr
 
consume() - Method in class org.snakeyaml.engine.v2.comments.CommentEventsCollector
Return the events collected and reset the collector.
createComposer(InputStream) - Method in class org.snakeyaml.engine.v2.api.Load
Create Composer
createComposer(String) - Method in class org.snakeyaml.engine.v2.api.Load
Create Composer
createComposer(Reader) - Method in class org.snakeyaml.engine.v2.api.Load
Create Composer
createEmptyListForNode(SequenceNode) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create List implementation.
createEmptyMapFor(MappingNode) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create Map implementation.
createEmptySetForNode(MappingNode) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Create Set implementation.
createIntNumber(String) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructYamlInt
Create number trying fist Integer, then Long, then BigInteger
createSnippet(int, int) - Method in class org.snakeyaml.engine.v2.exceptions.Mark
Create readable snippet
createSnippet() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
Create readable YAML with indent 4 and n ot longer that 75 characters long

D

decode(ByteBuffer) - Static method in class org.snakeyaml.engine.v2.common.UriEncoder
Decode '%'-escaped characters.
decode(String) - Static method in class org.snakeyaml.engine.v2.common.UriEncoder
Decode with URLDecoder
defaultFlowStyle - Variable in class org.snakeyaml.engine.v2.representer.BaseRepresenter
flow style for collections
defaultScalarStyle - Variable in class org.snakeyaml.engine.v2.representer.BaseRepresenter
scalar style
Dump - Class in org.snakeyaml.engine.v2.api
Common way to serialize any Java instance(s).
Dump(DumpSettings) - Constructor for class org.snakeyaml.engine.v2.api.Dump
Create instance
Dump(DumpSettings, BaseRepresenter) - Constructor for class org.snakeyaml.engine.v2.api.Dump
Create instance
dump(Object, StreamDataWriter) - Method in class org.snakeyaml.engine.v2.api.Dump
Dump a single instance into a YAML document
dumpAll(Iterator<? extends Object>, StreamDataWriter) - Method in class org.snakeyaml.engine.v2.api.Dump
Dump all the instances from the iterator into a stream with every instance in a separate YAML document
dumpAllToString(Iterator<? extends Object>) - Method in class org.snakeyaml.engine.v2.api.Dump
Dump all the instances from the iterator into a stream with every instance in a separate YAML document
dumpNode(Node, StreamDataWriter) - Method in class org.snakeyaml.engine.v2.api.Dump
Dump the provided Node into a YAML stream.
DumpSettings - Class in org.snakeyaml.engine.v2.api
Fine-tuning serializing/dumping Description for all the fields can be found in the builder
DumpSettingsBuilder - Class in org.snakeyaml.engine.v2.api
Builder pattern implementation for DumpSettings
dumpToString(Object) - Method in class org.snakeyaml.engine.v2.api.Dump
Dump all the instances from the iterator into a stream with every instance in a separate YAML document
DuplicateKeyException - Exception in org.snakeyaml.engine.v2.exceptions
Indicate duplicate keys in the same mapping during parsing
DuplicateKeyException(Optional<Mark>, Object, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.DuplicateKeyException
Create

E

emit(Event) - Method in interface org.snakeyaml.engine.v2.emitter.Emitable
Serialise event to bytes
emit(Event) - Method in class org.snakeyaml.engine.v2.emitter.Emitter
 
Emitable - Interface in org.snakeyaml.engine.v2.emitter
Drefine a way to serialize an event to output stream
emitStreamEnd() - Method in class org.snakeyaml.engine.v2.serializer.Serializer
Emit StreamEndEvent
emitStreamStart() - Method in class org.snakeyaml.engine.v2.serializer.Serializer
Emit StreamStartEvent
Emitter - Class in org.snakeyaml.engine.v2.emitter
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
Emitter(DumpSettings, StreamDataWriter) - Constructor for class org.snakeyaml.engine.v2.emitter.Emitter
Create
EmitterException - Exception in org.snakeyaml.engine.v2.exceptions
General exception for during emitting
EmitterException(String) - Constructor for exception org.snakeyaml.engine.v2.exceptions.EmitterException
Create
emitToString(Iterator<Event>) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Present
Serialise the provided Events
EMPTY - Static variable in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
No value indication
encode(String) - Static method in class org.snakeyaml.engine.v2.common.UriEncoder
Escape special characters with '%'
ENV_FORMAT - Static variable in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
group 1: name, group 2: separator, group 3: value
EnvConfig - Interface in org.snakeyaml.engine.v2.env
Configurator for ENV format
equals(Object) - Method in class org.snakeyaml.engine.v2.common.Anchor
 
ESCAPE_CODES - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
A mapping from a character to a number of bytes to read-ahead for that escape sequence.
ESCAPE_REPLACEMENTS - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
A mapping from an escaped character in the input stream to the character that they should be replaced with.
escapeChar(String) - Static method in class org.snakeyaml.engine.v2.common.CharConstants
Replace a single character with its string representation

F

findConstructorFor(Node) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
Select ConstructNode inside the provided Node or the one associated with the Tag
findRepresenterFor(Object) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Find the representer which is suitable to represent the internal structure of the provided instance to a Node
flattenMapping(MappingNode) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor
Flattening is not required because merge was removed from YAML 1.2 Only check duplications
FLOAT - Static variable in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Float as defined in JSON (Number which is Float)
FlowStyle - Enum in org.snakeyaml.engine.v2.common
Block styles use indentation to denote nesting and scope within the document.
flush() - Method in interface org.snakeyaml.engine.v2.api.StreamDataWriter
Flushes this stream by writing any buffered output to the underlying stream.
flush() - Method in class org.snakeyaml.engine.v2.api.YamlOutputStreamWriter
 
forward() - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
read the next character and move the pointer.
forward(int) - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
read the next length characters and move the pointer.

G

getAllowDuplicateKeys() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getAllowRecursiveKeys() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getAnchorGenerator() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getBestLineBreak() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getBuffer() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
getter
getBufferSize() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getCodePoint() - Method in exception org.snakeyaml.engine.v2.exceptions.ReaderException
getter
getCodePointLimit() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getColumn() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
starts with 0
getColumn() - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
 
getCommentType() - Method in class org.snakeyaml.engine.v2.comments.CommentLine
getter
getContext() - Method in exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
getter
getContextMark() - Method in exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
getter
getCustomProperty(SettingKey) - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getCustomProperty(SettingKey) - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getDefaultFlowStyle() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getDefaultList() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getDefaultMap() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getDefaultScalarStyle() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getDefaultSet() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getDumpComments() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getEncoding() - Method in class org.snakeyaml.engine.v2.api.YamlUnicodeReader
Get stream encoding or NULL if stream is uninitialized.
getEndMark() - Method in class org.snakeyaml.engine.v2.comments.CommentLine
getter
getEnv(String) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor.ConstructEnv
Get value of the environment variable
getEnvConfig() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getExplicitRootTag() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getIndent() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getIndentWithIndicator() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getIndex() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
starts with 0
getIndex() - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
 
getIndicatorIndent() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getLabel() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getLine() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
starts with 0
getLine() - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
 
getMajor() - Method in class org.snakeyaml.engine.v2.common.SpecVersion
getter
getMark() - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
Generate Mark if it is configured
getMaxAliasesForCollections() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getMaxSimpleKeyLength() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getMessage() - Method in exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
Getter
getMinor() - Method in class org.snakeyaml.engine.v2.common.SpecVersion
getter
getName() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
getter
getName() - Method in exception org.snakeyaml.engine.v2.exceptions.ReaderException
getter
getNonPrintableStyle() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getParseComments() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getPointer() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
getter
getPosition() - Method in exception org.snakeyaml.engine.v2.exceptions.ReaderException
getter
getProblem() - Method in exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
getter
getProblemMark() - Method in exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
getter
getRepresentation() - Method in class org.snakeyaml.engine.v2.common.SpecVersion
create readable text
getScalar() - Method in class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
getter
getScalarResolver() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getScalarResolver() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getSingleNode() - Method in class org.snakeyaml.engine.v2.composer.Composer
Reads a document from a source that contains only one document.
getSpecVersion() - Method in exception org.snakeyaml.engine.v2.exceptions.YamlVersionException
getter
getStartMark() - Method in class org.snakeyaml.engine.v2.comments.CommentLine
getter
getTag(Class<?>, Tag) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter
Define the way to get the Tag for any class
getTagConstructors() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getTagDirective() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getUseMarks() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getValue() - Method in class org.snakeyaml.engine.v2.comments.CommentLine
Value of this comment.
getValue() - Method in class org.snakeyaml.engine.v2.common.Anchor
getter
getValueFor(String, String, String, String) - Method in interface org.snakeyaml.engine.v2.env.EnvConfig
Implement deviation from the standard logic.
getVersionFunction() - Method in class org.snakeyaml.engine.v2.api.LoadSettings
 
getWidth() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
getYamlDirective() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 

H

has(int) - Method in class org.snakeyaml.engine.v2.common.CharConstants
 
has(int, String) - Method in class org.snakeyaml.engine.v2.common.CharConstants
 
hashCode() - Method in class org.snakeyaml.engine.v2.common.Anchor
 
hasNext() - Method in class org.snakeyaml.engine.v2.composer.Composer
Checks if further documents are available.
hasNext() - Method in class org.snakeyaml.engine.v2.parser.ParserImpl
Produce the event if not yet present.
hasNext() - Method in class org.snakeyaml.engine.v2.scanner.ScannerImpl
 
hasNo(int) - Method in class org.snakeyaml.engine.v2.common.CharConstants
 
hasNo(int, String) - Method in class org.snakeyaml.engine.v2.common.CharConstants
 

I

init() - Method in class org.snakeyaml.engine.v2.api.YamlUnicodeReader
Read-ahead four bytes and check for BOM marks.
INT - Static variable in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Integer as defined in JSON (Number which is Integer)
isAllowBlock() - Method in class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
getter
isAllowBlockPlain() - Method in class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
getter
isAllowFlowPlain() - Method in class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
getter
isAllowSingleQuoted() - Method in class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
getter
isCanonical() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
isEmpty() - Method in class org.snakeyaml.engine.v2.comments.CommentEventsCollector
Test if the collector contains any collected events.
isEmpty() - Method in class org.snakeyaml.engine.v2.common.ArrayStack
Check
isEmpty() - Method in class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
getter
isExplicitEnd() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
isExplicitStart() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
isMultiline() - Method in class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
getter
isMultiLineFlow() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
isPrintable(String) - Static method in class org.snakeyaml.engine.v2.scanner.StreamReader
Check if the all the data is human-readable (used in Representer)
isPrintable(int) - Static method in class org.snakeyaml.engine.v2.scanner.StreamReader
Check if the code point is human-readable
isSplitLines() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 
isUseUnicodeEncoding() - Method in class org.snakeyaml.engine.v2.api.DumpSettings
 

J

JsonScalarResolver - Class in org.snakeyaml.engine.v2.resolver
ScalarResolver for JSON Schema The schema is NOT the same as in YAML 1.2 but identical to JSON,
JsonScalarResolver() - Constructor for class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Create

L

LINEBR - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
Load - Class in org.snakeyaml.engine.v2.api
Common way to load Java instance(s).
Load(LoadSettings) - Constructor for class org.snakeyaml.engine.v2.api.Load
Create instance to parse the incoming YAML data and create Java instances
Load(LoadSettings, BaseConstructor) - Constructor for class org.snakeyaml.engine.v2.api.Load
Create instance to parse the incoming YAML data and create Java instances
loadAllFromInputStream(InputStream) - Method in class org.snakeyaml.engine.v2.api.Load
Parse all YAML documents in a stream and produce corresponding Java objects.
loadAllFromReader(Reader) - Method in class org.snakeyaml.engine.v2.api.Load
Parse all YAML documents in a String and produce corresponding Java objects.
loadAllFromString(String) - Method in class org.snakeyaml.engine.v2.api.Load
Parse all YAML documents in a String and produce corresponding Java objects.
loadFromInputStream(InputStream) - Method in class org.snakeyaml.engine.v2.api.Load
Parse the only YAML document in a stream and produce the corresponding Java object.
loadFromReader(Reader) - Method in class org.snakeyaml.engine.v2.api.Load
Parse a YAML document and create a Java instance
loadFromString(String) - Method in class org.snakeyaml.engine.v2.api.Load
Parse a YAML document and create a Java instance
loadOne(Composer) - Method in class org.snakeyaml.engine.v2.api.Load
Load with provided Composer
LoadSettings - Class in org.snakeyaml.engine.v2.api
Fine-tuning parsing/loading.
LoadSettingsBuilder - Class in org.snakeyaml.engine.v2.api
Builder pattern implementation for LoadSettings

M

Mark - Class in org.snakeyaml.engine.v2.exceptions
Location of a problem in the YAML document.
Mark(String, int, int, int, int[], int) - Constructor for class org.snakeyaml.engine.v2.exceptions.Mark
Creates Mark
Mark(String, int, int, int, char[], int) - Constructor for class org.snakeyaml.engine.v2.exceptions.Mark
This constructor is only for test
MarkedYamlEngineException - Exception in org.snakeyaml.engine.v2.exceptions
Parsing exception when the marks are available
MarkedYamlEngineException(String, Optional<Mark>, String, Optional<Mark>, Throwable) - Constructor for exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
Create
MarkedYamlEngineException(String, Optional<Mark>, String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
Create
MAX_INDENT - Static variable in class org.snakeyaml.engine.v2.emitter.Emitter
indent should not be more than 10 spaces
MIN_INDENT - Static variable in class org.snakeyaml.engine.v2.emitter.Emitter
indent cannot be zero spaces
MissingEnvironmentVariableException - Exception in org.snakeyaml.engine.v2.exceptions
Indicate missing mandatory environment variable in the template
MissingEnvironmentVariableException(String) - Constructor for exception org.snakeyaml.engine.v2.exceptions.MissingEnvironmentVariableException
Create
MULTILINE_PATTERN - Static variable in class org.snakeyaml.engine.v2.representer.StandardRepresenter
all chars that represent a new line

N

next() - Method in class org.snakeyaml.engine.v2.composer.Composer
Reads and composes the next document.
next() - Method in interface org.snakeyaml.engine.v2.parser.Parser
Returns the next event.
next() - Method in class org.snakeyaml.engine.v2.parser.ParserImpl
Consume the event (get the next event and removed it).
next() - Method in interface org.snakeyaml.engine.v2.scanner.Scanner
Returns the next token.
next() - Method in class org.snakeyaml.engine.v2.scanner.ScannerImpl
Return the next token, removing it from the queue.
nextAnchor(Node) - Method in interface org.snakeyaml.engine.v2.serializer.AnchorGenerator
Create anchor
nextAnchor(Node) - Method in class org.snakeyaml.engine.v2.serializer.NumberAnchorGenerator
Create value increasing the number
NonPrintableStyle - Enum in org.snakeyaml.engine.v2.common
Configure the style when String contains non-printable characters
NULL - Static variable in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Null as defined in JSON
NULL_BL_LINEBR - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
NULL_BL_T - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
NULL_BL_T_LINEBR - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
NULL_OR_LINEBR - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
nullRepresenter - Variable in class org.snakeyaml.engine.v2.representer.BaseRepresenter
in Java 'null' is not a type.
NumberAnchorGenerator - Class in org.snakeyaml.engine.v2.serializer
Simple generate of the format id + number
NumberAnchorGenerator(int) - Constructor for class org.snakeyaml.engine.v2.serializer.NumberAnchorGenerator
Create

O

objectToRepresent - Variable in class org.snakeyaml.engine.v2.representer.BaseRepresenter
the current object to be converted to Node
org.snakeyaml.engine.v2.api - package org.snakeyaml.engine.v2.api
 
org.snakeyaml.engine.v2.api.lowlevel - package org.snakeyaml.engine.v2.api.lowlevel
 
org.snakeyaml.engine.v2.comments - package org.snakeyaml.engine.v2.comments
 
org.snakeyaml.engine.v2.common - package org.snakeyaml.engine.v2.common
 
org.snakeyaml.engine.v2.composer - package org.snakeyaml.engine.v2.composer
 
org.snakeyaml.engine.v2.constructor - package org.snakeyaml.engine.v2.constructor
 
org.snakeyaml.engine.v2.emitter - package org.snakeyaml.engine.v2.emitter
 
org.snakeyaml.engine.v2.env - package org.snakeyaml.engine.v2.env
 
org.snakeyaml.engine.v2.exceptions - package org.snakeyaml.engine.v2.exceptions
 
org.snakeyaml.engine.v2.parser - package org.snakeyaml.engine.v2.parser
 
org.snakeyaml.engine.v2.representer - package org.snakeyaml.engine.v2.representer
 
org.snakeyaml.engine.v2.resolver - package org.snakeyaml.engine.v2.resolver
 
org.snakeyaml.engine.v2.scanner - package org.snakeyaml.engine.v2.scanner
 
org.snakeyaml.engine.v2.serializer - package org.snakeyaml.engine.v2.serializer
 

P

parentClassRepresenters - Variable in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Keep representers which match a parent of the class to be represented
Parse - Class in org.snakeyaml.engine.v2.api.lowlevel
Read the input stream and parse the content into events (opposite for Present or Emit)
Parse(LoadSettings) - Constructor for class org.snakeyaml.engine.v2.api.lowlevel.Parse
Create instance with provided LoadSettings
parseInputStream(InputStream) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Parse
Parse a YAML stream and produce parsing events.
parser - Variable in class org.snakeyaml.engine.v2.composer.Composer
Event parser
Parser - Interface in org.snakeyaml.engine.v2.parser
This interface represents an input stream of Events.
parseReader(Reader) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Parse
Parse a YAML stream and produce parsing events.
ParserException - Exception in org.snakeyaml.engine.v2.exceptions
Exception thrown by the Parser implementations in case of malformed input.
ParserException(String, Optional<Mark>, String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ParserException
Constructs an instance.
ParserException(String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ParserException
Create
ParserImpl - Class in org.snakeyaml.engine.v2.parser
# The following YAML grammar is LL(1) and is parsed by a recursive descent parser.
ParserImpl(StreamReader, LoadSettings) - Constructor for class org.snakeyaml.engine.v2.parser.ParserImpl
Deprecated.
use the other constructor with LoadSettings first
ParserImpl(LoadSettings, StreamReader) - Constructor for class org.snakeyaml.engine.v2.parser.ParserImpl
Create
ParserImpl(Scanner, LoadSettings) - Constructor for class org.snakeyaml.engine.v2.parser.ParserImpl
Deprecated.
use the other constructor with LoadSettings first
ParserImpl(LoadSettings, Scanner) - Constructor for class org.snakeyaml.engine.v2.parser.ParserImpl
Create
parseString(String) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Parse
Parse a YAML stream and produce parsing events.
peek() - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
Peek the next code point (look without moving the pointer)
peek(int) - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
Peek the next index-th code point
peekEvent() - Method in interface org.snakeyaml.engine.v2.parser.Parser
Return the next event, but do not delete it from the stream.
peekEvent() - Method in class org.snakeyaml.engine.v2.parser.ParserImpl
Get the next event (and keep it).
peekToken() - Method in interface org.snakeyaml.engine.v2.scanner.Scanner
Return the next token, but do not delete it from the stream.
peekToken() - Method in class org.snakeyaml.engine.v2.scanner.ScannerImpl
Return the next token, but do not delete it from the queue.
pop() - Method in class org.snakeyaml.engine.v2.common.ArrayStack
Get the head and remove it from the stack
postponeMapFilling(Map<Object, Object>, Object, Object) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
if keyObject is created it 2 steps we should postpone putting it in map because it may have different hash after initialization compared to clean just created one.
postponeSetFilling(Set<Object>, Object) - Method in class org.snakeyaml.engine.v2.constructor.BaseConstructor
if keyObject is created it 2 steps we should postpone putting it into the set because it may have different hash after initialization compared to clean just created one.
prefix(int) - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
Create String from code points
prefixForward(int) - Method in class org.snakeyaml.engine.v2.scanner.StreamReader
prefix(length) immediately followed by forward(length)
Present - Class in org.snakeyaml.engine.v2.api.lowlevel
Emit the events into a data stream (opposite for Parse)
Present(DumpSettings) - Constructor for class org.snakeyaml.engine.v2.api.lowlevel.Present
Create Present (emitter)
processDuplicateKeys(MappingNode) - Method in class org.snakeyaml.engine.v2.constructor.StandardConstructor
detect and process the duplicate key in mapping according to the configured setting
processIOException(IOException) - Method in class org.snakeyaml.engine.v2.api.YamlOutputStreamWriter
to be implemented
push(T) - Method in class org.snakeyaml.engine.v2.common.ArrayStack
Add the element to the head

R

read(char[], int, int) - Method in class org.snakeyaml.engine.v2.api.YamlUnicodeReader
 
ReaderException - Exception in org.snakeyaml.engine.v2.exceptions
Indicate invalid input stream
ReaderException(String, int, int, String) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ReaderException
Create
represent(Object) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Represent the provided Java instance to a Node
RepresentArray() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentArray
 
RepresentBoolean() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentBoolean
 
RepresentByteArray() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentByteArray
 
representData(Object) - Method in interface org.snakeyaml.engine.v2.api.RepresentToNode
Create a Node
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Find the representer and use it to create the Node from instance
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentArray
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentBoolean
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentByteArray
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentEnum
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentIterator
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentList
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentMap
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentNull
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentNumber
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentOptional
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentPrimitiveArray
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentSet
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentString
 
representData(Object) - Method in class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentUuid
 
representedObjects - Variable in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Keep references of already represented instances
RepresentEnum() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentEnum
 
representer - Variable in class org.snakeyaml.engine.v2.api.Dump
The component to translate Java instances to Nodes
representers - Variable in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Keep representers which must match the class exactly
RepresentIterator() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentIterator
 
RepresentList() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentList
 
RepresentMap() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentMap
 
representMapping(Tag, Map<?, ?>, FlowStyle) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Create Node for the provided Map
representMappingEntry(Map.Entry<?, ?>) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Create a tuple for one key pair
RepresentNull() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentNull
 
RepresentNumber() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentNumber
 
RepresentOptional() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentOptional
 
RepresentPrimitiveArray() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentPrimitiveArray
 
representScalar(Tag, String, ScalarStyle) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Create Scalar Node from string
representScalar(Tag, String) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Create Node for string using PLAIN scalar style if possible
representSequence(Tag, Iterable<?>, FlowStyle) - Method in class org.snakeyaml.engine.v2.representer.BaseRepresenter
Create Node
RepresentSet() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentSet
 
RepresentString() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentString
 
RepresentToNode - Interface in org.snakeyaml.engine.v2.api
Create a Node Graph out of the provided Native Data Structure (Java instance).
RepresentUuid() - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter.RepresentUuid
 
resolve(String, Boolean) - Method in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
 
resolve(String, Boolean) - Method in interface org.snakeyaml.engine.v2.resolver.ScalarResolver
Resolve (detect) the tag of the scalar node of the given type.

S

ScalarAnalysis - Class in org.snakeyaml.engine.v2.emitter
Accumulate information to choose the scalar style
ScalarAnalysis(String, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class org.snakeyaml.engine.v2.emitter.ScalarAnalysis
Create
ScalarResolver - Interface in org.snakeyaml.engine.v2.resolver
ScalarResolver tries to detect a type of a scalar value by its content (when the tag is implicit)
ScalarStyle - Enum in org.snakeyaml.engine.v2.common
YAML provides a rich set of scalar styles.
scanner - Variable in class org.snakeyaml.engine.v2.parser.ParserImpl
tokeniser
Scanner - Interface in org.snakeyaml.engine.v2.scanner
This interface represents an input stream of Tokens.
ScannerException - Exception in org.snakeyaml.engine.v2.exceptions
Exception thrown by the Scanner implementations in case of malformed input.
ScannerException(String, Optional<Mark>, String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ScannerException
Constructs an instance.
ScannerException(String, Optional<Mark>) - Constructor for exception org.snakeyaml.engine.v2.exceptions.ScannerException
Create
ScannerImpl - Class in org.snakeyaml.engine.v2.scanner
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.
ScannerImpl(StreamReader, LoadSettings) - Constructor for class org.snakeyaml.engine.v2.scanner.ScannerImpl
Deprecated.
use the other constructor with LoadSettings first
ScannerImpl(LoadSettings, StreamReader) - Constructor for class org.snakeyaml.engine.v2.scanner.ScannerImpl
Create
ScannerImpl(StreamReader) - Constructor for class org.snakeyaml.engine.v2.scanner.ScannerImpl
Deprecated.
it should be used with LoadSettings
Serialize - Class in org.snakeyaml.engine.v2.api.lowlevel
Implementation of the step which translates Nodes to Events
Serialize(DumpSettings) - Constructor for class org.snakeyaml.engine.v2.api.lowlevel.Serialize
Create instance with provided DumpSettings
serializeAll(List<Node>) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Serialize
Serialize Nodes and produce events.
serializeDocument(Node) - Method in class org.snakeyaml.engine.v2.serializer.Serializer
Serialize document
serializeOne(Node) - Method in class org.snakeyaml.engine.v2.api.lowlevel.Serialize
Serialize a Node and produce events.
Serializer - Class in org.snakeyaml.engine.v2.serializer
Transform a Node Graph to Event stream and allow provided Emitable to present the Events into the output stream
Serializer(DumpSettings, Emitable) - Constructor for class org.snakeyaml.engine.v2.serializer.Serializer
Create Serializer
setAllowDuplicateKeys(boolean) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
YAML 1.2 does require unique keys.
setAllowRecursiveKeys(boolean) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Allow only non-recursive keys for maps and sets.
setAnchorGenerator(AnchorGenerator) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define anchor name generator (by default 'id' + number)
setBestLineBreak(String) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
If the YAML is created for another platform (for instance on Windows to be consumed under Linux) than this setting is used to define the line ending.
setBufferSize(Integer) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Buffer size for incoming data stream.
setCanonical(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Enforce canonical representation
setCodePointLimit(int) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
The max amount of code points in the input YAML document.
setCustomProperty(SettingKey, Object) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Custom property is the way to give some runtime parameters to be used during dumping
setCustomProperty(SettingKey, Object) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Provide a custom property to be used later
setDefaultFlowStyle(FlowStyle) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define flow style
setDefaultList(IntFunction<List<Object>>) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Provide default List implementation.
setDefaultMap(IntFunction<Map<Object, Object>>) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Provide default Map implementation.
setDefaultScalarStyle(ScalarStyle) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define default scalar style
setDefaultSet(IntFunction<Set<Object>>) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Provide default Set implementation.
setDumpComments(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Set to true to add comments from Nodes to
setEnvConfig(Optional<EnvConfig>) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Define EnvConfig to parse EVN format.
setExplicitEnd(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Add '...' in the end of the document
setExplicitRootTag(Optional<Tag>) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define root Tag or let the tag to be detected automatically
setExplicitStart(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Add '---' in the beginning of the document
setIndent(int) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define the amount of the spaces for the indent in the block flow style.
setIndentWithIndicator(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Set to true to add the indent for sequences to the general indent
setIndicatorIndent(int) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
It adds the specified indent for sequence indicator in the block flow.
setLabel(String) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Label for the input data.
setMaxAliasesForCollections(int) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Restrict the number of aliases for collection nodes to prevent Billion laughs attack.
setMaxSimpleKeyLength(int) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define max key length to use simple key (without '?') More info https://yaml.org/spec/1.2/spec.html#id2798057
setMultiLineFlow(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Use pretty flow style when every value in the flow context gets a separate line.
setNonPrintableStyle(NonPrintableStyle) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
When String object contains non-printable characters, they are escaped with \\u or \\x notation.
setParseComments(boolean) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Parse comments to the presentation tree (Node).
setScalarResolver(ScalarResolver) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define ScalarResolver or use JSON resolver by default.
setScalarResolver(ScalarResolver) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Provide resolver to detect a tag by the value of a scalar
setSplitLines(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Define whether to split long lines
setTagConstructors(Map<Tag, ConstructNode>) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Provide constructors for the specified tags.
setTagDirective(Map<String, String>) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Add TAG directive
SettingKey - Interface in org.snakeyaml.engine.v2.api
Type for the custom keys in settings.
settings - Variable in class org.snakeyaml.engine.v2.api.Dump
Configuration options
settings - Variable in class org.snakeyaml.engine.v2.constructor.BaseConstructor
keep the settings
settings - Variable in class org.snakeyaml.engine.v2.representer.StandardRepresenter
keep the options
setUseMarks(boolean) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Marks are only used for error messages.
setUseUnicodeEncoding(boolean) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Specify whether to emit non-ASCII printable Unicode characters (emit Unicode char or escape sequence starting with '\\u') The default value is true.
setVersionFunction(UnaryOperator<SpecVersion>) - Method in class org.snakeyaml.engine.v2.api.LoadSettingsBuilder
Manage YAML directive value which defines the version of the YAML specification.
setWidth(int) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Set max width for literal scalars.
setYamlDirective(Optional<SpecVersion>) - Method in class org.snakeyaml.engine.v2.api.DumpSettingsBuilder
Add YAML directive
SpecVersion - Class in org.snakeyaml.engine.v2.common
YAML Version indicator
SpecVersion(int, int) - Constructor for class org.snakeyaml.engine.v2.common.SpecVersion
Create
StandardConstructor - Class in org.snakeyaml.engine.v2.constructor
Construct standard Java classes
StandardConstructor(LoadSettings) - Constructor for class org.snakeyaml.engine.v2.constructor.StandardConstructor
Create
StandardConstructor.ConstructEnv - Class in org.snakeyaml.engine.v2.constructor
Construct scalar for format ${VARIABLE} replacing the template with the value from environment.
StandardConstructor.ConstructOptionalClass - Class in org.snakeyaml.engine.v2.constructor
Create instances of Optional
StandardConstructor.ConstructUuidClass - Class in org.snakeyaml.engine.v2.constructor
Create instances of UUID class
StandardConstructor.ConstructYamlBinary - Class in org.snakeyaml.engine.v2.constructor
Create instances bytes for binary
StandardConstructor.ConstructYamlBool - Class in org.snakeyaml.engine.v2.constructor
Create Boolean instances
StandardConstructor.ConstructYamlFloat - Class in org.snakeyaml.engine.v2.constructor
Create Double instances for float
StandardConstructor.ConstructYamlInt - Class in org.snakeyaml.engine.v2.constructor
Create instances for numbers (Integer, Long, BigInteger)
StandardConstructor.ConstructYamlMap - Class in org.snakeyaml.engine.v2.constructor
Create Map instance
StandardConstructor.ConstructYamlNull - Class in org.snakeyaml.engine.v2.constructor
Create null
StandardConstructor.ConstructYamlSeq - Class in org.snakeyaml.engine.v2.constructor
Create the List implementation (configured in setting)
StandardConstructor.ConstructYamlSet - Class in org.snakeyaml.engine.v2.constructor
Create Set instances
StandardConstructor.ConstructYamlStr - Class in org.snakeyaml.engine.v2.constructor
Create String instances
StandardRepresenter - Class in org.snakeyaml.engine.v2.representer
Represent standard Java classes
StandardRepresenter(DumpSettings) - Constructor for class org.snakeyaml.engine.v2.representer.StandardRepresenter
Create
StandardRepresenter.RepresentArray - Class in org.snakeyaml.engine.v2.representer
Create Node for Object[]
StandardRepresenter.RepresentBoolean - Class in org.snakeyaml.engine.v2.representer
Create Node for Boolean
StandardRepresenter.RepresentByteArray - Class in org.snakeyaml.engine.v2.representer
Create Node for byte[]
StandardRepresenter.RepresentEnum - Class in org.snakeyaml.engine.v2.representer
Create eNode for Enums
StandardRepresenter.RepresentIterator - Class in org.snakeyaml.engine.v2.representer
Create Node for Iterator
StandardRepresenter.RepresentList - Class in org.snakeyaml.engine.v2.representer
Create Node for List
StandardRepresenter.RepresentMap - Class in org.snakeyaml.engine.v2.representer
Create Node for Map instance
StandardRepresenter.RepresentNull - Class in org.snakeyaml.engine.v2.representer
Create null Node
StandardRepresenter.RepresentNumber - Class in org.snakeyaml.engine.v2.representer
Create Node for Byte, Short, Integer, Long, BigInteger
StandardRepresenter.RepresentOptional - Class in org.snakeyaml.engine.v2.representer
Create Node for Optional instance (the value of null)
StandardRepresenter.RepresentPrimitiveArray - Class in org.snakeyaml.engine.v2.representer
Represents primitive arrays, such as short[] and float[], by converting them into equivalent List using the appropriate autoboxing type.
StandardRepresenter.RepresentSet - Class in org.snakeyaml.engine.v2.representer
Create Node for Set instances
StandardRepresenter.RepresentString - Class in org.snakeyaml.engine.v2.representer
Create Node for String
StandardRepresenter.RepresentUuid - Class in org.snakeyaml.engine.v2.representer
Create Node for UUID
StreamDataWriter - Interface in org.snakeyaml.engine.v2.api
Writer with the same methods as in Writer but without throwing IOExceptions The purpose of this class is to avoid checked exceptions in every method signature.
StreamReader - Class in org.snakeyaml.engine.v2.scanner
Read the provided stream of code points into String and implement look-ahead operations.
StreamReader(Reader, LoadSettings) - Constructor for class org.snakeyaml.engine.v2.scanner.StreamReader
Deprecated.
use the other constructor with LoadSettings first
StreamReader(LoadSettings, Reader) - Constructor for class org.snakeyaml.engine.v2.scanner.StreamReader
Create
StreamReader(String, LoadSettings) - Constructor for class org.snakeyaml.engine.v2.scanner.StreamReader
Deprecated.
use the other constructor with LoadSettings first
StreamReader(LoadSettings, String) - Constructor for class org.snakeyaml.engine.v2.scanner.StreamReader
Create

T

tagConstructors - Variable in class org.snakeyaml.engine.v2.constructor.BaseConstructor
It maps the (explicit or implicit) tag to the Construct implementation.
toString() - Method in class org.snakeyaml.engine.v2.comments.CommentLine
 
toString() - Method in class org.snakeyaml.engine.v2.common.Anchor
 
toString() - Method in enum org.snakeyaml.engine.v2.common.ScalarStyle
 
toString() - Method in class org.snakeyaml.engine.v2.common.SpecVersion
 
toString() - Method in class org.snakeyaml.engine.v2.exceptions.Mark
 
toString() - Method in exception org.snakeyaml.engine.v2.exceptions.MarkedYamlEngineException
get readable error
toString() - Method in exception org.snakeyaml.engine.v2.exceptions.ReaderException
 

U

URI_CHARS_FOR_TAG_PREFIX - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
URI_CHARS_FOR_TAG_SUFFIX - Static variable in class org.snakeyaml.engine.v2.common.CharConstants
 
UriEncoder - Class in org.snakeyaml.engine.v2.common
To be decided

V

valueOf(String) - Static method in enum org.snakeyaml.engine.v2.comments.CommentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.snakeyaml.engine.v2.common.FlowStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.snakeyaml.engine.v2.common.NonPrintableStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.snakeyaml.engine.v2.common.ScalarStyle
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.snakeyaml.engine.v2.comments.CommentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.snakeyaml.engine.v2.common.FlowStyle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.snakeyaml.engine.v2.common.NonPrintableStyle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.snakeyaml.engine.v2.common.ScalarStyle
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(String) - Method in interface org.snakeyaml.engine.v2.api.StreamDataWriter
write the whole data
write(String, int, int) - Method in interface org.snakeyaml.engine.v2.api.StreamDataWriter
Write part of the data
write(String, int, int) - Method in class org.snakeyaml.engine.v2.api.YamlOutputStreamWriter
 
write(String) - Method in class org.snakeyaml.engine.v2.api.YamlOutputStreamWriter
 

Y

YamlEngineException - Exception in org.snakeyaml.engine.v2.exceptions
General exception to serve as the root
YamlEngineException(String) - Constructor for exception org.snakeyaml.engine.v2.exceptions.YamlEngineException
Create
YamlEngineException(Throwable) - Constructor for exception org.snakeyaml.engine.v2.exceptions.YamlEngineException
Create
YamlEngineException(String, Throwable) - Constructor for exception org.snakeyaml.engine.v2.exceptions.YamlEngineException
Create
yamlImplicitResolvers - Variable in class org.snakeyaml.engine.v2.resolver.JsonScalarResolver
Map from the char to the resolver which may begin with this char
YamlOutputStreamWriter - Class in org.snakeyaml.engine.v2.api
Provide an example of implementation of StreamDataWriter interface which does not throw IOException
YamlOutputStreamWriter(OutputStream, Charset) - Constructor for class org.snakeyaml.engine.v2.api.YamlOutputStreamWriter
Create
YamlUnicodeReader - Class in org.snakeyaml.engine.v2.api
Generic unicode textreader, which will use BOM mark to identify the encoding to be used.
YamlUnicodeReader(InputStream) - Constructor for class org.snakeyaml.engine.v2.api.YamlUnicodeReader
 
YamlVersionException - Exception in org.snakeyaml.engine.v2.exceptions
Indication of invalid YAML version
YamlVersionException(SpecVersion) - Constructor for exception org.snakeyaml.engine.v2.exceptions.YamlVersionException
Create
A B C D E F G H I J L M N O P R S T U V W Y 
Skip navigation links

Copyright © 2018–2022. All rights reserved.