org.simpleyaml.configuration.comments

Class YamlCommentReader

java.lang.Object

org.simpleyaml.configuration.comments.YamlCommentMapper

org.simpleyaml.configuration.comments.YamlCommentReader

All Implemented Interfaces:

Closeable, AutoCloseable, Commentable

Direct Known Subclasses:

YamlCommentDumper, YamlCommentParser

public abstract class YamlCommentReader
extends YamlCommentMapper
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	YamlCommentReader.ReaderStage
class	YamlCommentReader.ReadingExplicitStyle
static class	YamlCommentReader.ReadingQuoteStyle

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	beginExplicit
protected char	currentChar
protected String	currentLine
protected KeyTree.Node	currentList
protected KeyTree.Node	currentNode
protected YamlCommentReader.ReadingExplicitStyle	explicitNotation
protected int	indent
protected boolean	isEscaping
protected boolean	isListElement
protected boolean	isLiteral
protected String	key
protected int	position
protected YamlCommentReader.ReadingQuoteStyle	quoteNotation
protected YamlCommentReader.ReaderStage	stage
protected String	trim

Fields inherited from class org.simpleyaml.configuration.comments.YamlCommentMapper

keyTree, NO_COMMENTS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YamlCommentReader(YamlConfigurationOptions options)

Method Summary

Modifier and Type	Method and Description
protected boolean	canStartComment()
protected boolean	canStartSpecialIndent(int indent)
protected boolean	checkSpecialChars()
protected void	checkSpecialLines(boolean wasLiteral, int indent)
protected void	clearCurrentNode()
protected void	clearCurrentNodeIfNoComments()
protected void	endExplicitBlock()
protected void	endExplicitNotation()
protected boolean	hasChar()
protected boolean	hasKey()
protected boolean	hasNext()
protected void	inQuote(YamlCommentReader.ReadingQuoteStyle quoteStyle)
protected boolean	isBlank()
protected boolean	isComment()
protected boolean	isExplicit()
protected boolean	isExplicitChar()
protected boolean	isInQuote()
protected boolean	isListChar()
protected boolean	isLiteralChar()
protected boolean	isMultiline()
protected boolean	isSectionEnd()
protected boolean	isSectionKey()
static boolean	isSpace(char c)
protected boolean	nextChar()
protected boolean	nextIsSpace()
protected boolean	nextLine()
protected char	peek(int offset)
protected void	processLine()
protected void	processMultiline(boolean inQuoteBlock)
protected int	readIndent()
protected int	readIndent(boolean special)
protected String	readKey()
protected void	readKeyMultiline(StringBuilder keyBuilder)
protected abstract String	readLine()
protected void	readTag()
protected void	readValue()
protected void	readValueMultiline()
protected void	skipToEnd()
String	toString()
protected KeyTree.Node	track()
protected KeyTree.Node	track(int indent, String key)
protected KeyTree.Node	trackExplicit()
protected void	trackListElement()

Methods inherited from class org.simpleyaml.configuration.comments.YamlCommentMapper

clearNode, clearNodeIfNoComments, getComment, getComment, getKeyTree, getNode, getOrAddNode, getPriorityNode, getRawComment, getRawComment, options, removeComment, removeComment, setComment, setFormattedComment, setRawComment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.simpleyaml.configuration.comments.Commentable

getComment, setComment

Field Detail

currentLine

protected String currentLine

trim

protected String trim

indent

protected int indent

key

protected String key

position

protected int position

currentChar

protected char currentChar

isEscaping

protected boolean isEscaping

isLiteral

protected boolean isLiteral

quoteNotation

protected YamlCommentReader.ReadingQuoteStyle quoteNotation

beginExplicit

protected boolean beginExplicit

explicitNotation

protected YamlCommentReader.ReadingExplicitStyle explicitNotation

currentNode

protected KeyTree.Node currentNode

currentList

protected KeyTree.Node currentList

isListElement

protected boolean isListElement

stage

protected YamlCommentReader.ReaderStage stage

Constructor Detail

YamlCommentReader

protected YamlCommentReader(YamlConfigurationOptions options)

Method Detail

readLine

protected abstract String readLine()
                            throws IOException

Throws:

IOException

nextLine

protected boolean nextLine()
                    throws IOException

Throws:

IOException

nextChar

protected boolean nextChar()

hasChar

protected boolean hasChar()

hasNext

protected boolean hasNext()

peek

protected char peek(int offset)

isBlank

protected boolean isBlank()

isSpace

public static boolean isSpace(char c)

isComment

protected boolean isComment()

canStartComment

protected boolean canStartComment()

isInQuote

protected boolean isInQuote()

isExplicit

protected boolean isExplicit()

endExplicitNotation

protected void endExplicitNotation()
                            throws IOException

Throws:

IOException

processLine

protected void processLine()
                    throws IOException

Throws:

IOException

processMultiline

protected void processMultiline(boolean inQuoteBlock)
                         throws IOException

Throws:

IOException

endExplicitBlock

protected void endExplicitBlock()
                         throws IOException

Throws:

IOException

isLiteralChar

protected boolean isLiteralChar()

checkSpecialLines

protected void checkSpecialLines(boolean wasLiteral,
                                 int indent)
                          throws IOException

Throws:

IOException

checkSpecialChars

protected boolean checkSpecialChars()

inQuote

protected void inQuote(YamlCommentReader.ReadingQuoteStyle quoteStyle)

isSectionKey

protected boolean isSectionKey()

readTag

protected void readTag()

readIndent

protected int readIndent(boolean special)

readIndent

protected int readIndent()

canStartSpecialIndent

protected boolean canStartSpecialIndent(int indent)

isListChar

protected boolean isListChar()

isExplicitChar

protected boolean isExplicitChar()

nextIsSpace

protected final boolean nextIsSpace()

isMultiline

protected final boolean isMultiline()

hasKey

protected boolean hasKey()

readKey

protected String readKey()
                  throws IOException

Throws:

IOException

readKeyMultiline

protected void readKeyMultiline(StringBuilder keyBuilder)
                         throws IOException

Throws:

IOException

readValue

protected void readValue()
                  throws IOException

Throws:

IOException

readValueMultiline

protected void readValueMultiline()
                           throws IOException

Throws:

IOException

skipToEnd

protected void skipToEnd()

isSectionEnd

protected boolean isSectionEnd()

track

protected KeyTree.Node track()
                      throws IOException

Throws:

IOException

trackListElement

protected void trackListElement()

trackExplicit

protected KeyTree.Node trackExplicit()
                              throws IOException

Throws:

IOException

track

protected KeyTree.Node track(int indent,
                             String key)

clearCurrentNode

protected void clearCurrentNode()

clearCurrentNodeIfNoComments

protected void clearCurrentNodeIfNoComments()

toString

public String toString()

Overrides:

toString in class Object