Package org.simpleyaml.configuration.comments

Class YamlCommentDumper

java.lang.Object

org.simpleyaml.configuration.comments.YamlCommentMapper

org.simpleyaml.configuration.comments.YamlCommentReader

org.simpleyaml.configuration.comments.YamlCommentDumper

All Implemented Interfaces:

Closeable, AutoCloseable, Commentable

public class YamlCommentDumper
extends YamlCommentReader

Nested Class Summary

Nested classes/interfaces inherited from class org.simpleyaml.configuration.comments.YamlCommentReader

YamlCommentReader.ReaderStage, YamlCommentReader.ReadingExplicitStyle, YamlCommentReader.ReadingQuoteStyle

Field Summary

Fields

Modifier and Type	Field	Description
protected final DumperBus	bus
protected KeyTree.Node	commentNode
protected KeyTree.Node	commentNodeFallback
protected StringWriter	explicitBlock
protected KeyTree.Node	firstListMapElement
protected StringWriter	multilineKeyBlock
protected BufferedWriter	writer
protected final YamlCommentMapper	yamlCommentMapper

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

beginExplicit, currentChar, currentLine, currentList, currentNode, explicitNotation, indent, isEscaping, isListElement, isLiteral, key, position, quoteNotation, stage, trim

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

keyTree, NO_COMMENTS

Constructor Summary

Constructors

Constructor	Description
YamlCommentDumper(YamlCommentMapper yamlCommentMapper, DumperBus.Dumper source, Writer writer)

Method Summary

Modifier and Type	Method	Description
protected void	appendBlockComment()
protected void	appendBlockComment(String comment)
protected void	appendSideComment()
protected void	appendSideCommentLiteral(String sideComment)
protected void	checkFirstListMapElement(KeyTree.Node commentNode, KeyTree.Node readerNode)
protected void	clearSection()
void	close()
void	dump()	Merge comments from the comment mapper with lines from the source.
void	getCommentNode(KeyTree.Node readerNode)
KeyTree.Node	getNode(String path)
protected void	processLine()
protected void	processMultiline(boolean inQuoteBlock)
protected void	readKeyMultiline(StringBuilder keyBuilder)
protected String	readLine()
protected void	readValue()
protected void	skipMultiline()

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

canStartComment, canStartSpecialIndent, checkSpecialChars, checkSpecialLines, clearCurrentNode, clearCurrentNodeIfNoComments, endExplicitBlock, endExplicitNotation, hasChar, hasKey, hasNext, inQuote, isBlank, isComment, isExplicit, isExplicitChar, isInQuote, isListChar, isLiteralChar, isMultiline, isSectionEnd, isSectionKey, isSpace, nextChar, nextIsSpace, nextLine, peek, readIndent, readIndent, readKey, readTag, readValueMultiline, skipToEnd, toString, track, track, trackExplicit, trackListElement, trackListElement

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

clearNode, clearNodeIfNoComments, getComment, getComment, getKeyTree, 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 org.simpleyaml.configuration.comments.Commentable

getComment, setComment

Field Details

yamlCommentMapper

protected final YamlCommentMapper yamlCommentMapper

bus

protected final DumperBus bus

writer

protected BufferedWriter writer

explicitBlock

protected StringWriter explicitBlock

multilineKeyBlock

protected StringWriter multilineKeyBlock

commentNode

protected KeyTree.Node commentNode

commentNodeFallback

protected KeyTree.Node commentNodeFallback

firstListMapElement

protected KeyTree.Node firstListMapElement

Constructor Details

YamlCommentDumper

public YamlCommentDumper(YamlCommentMapper yamlCommentMapper,
 DumperBus.Dumper source,
 Writer writer)

Method Details

dump

public void dump()
          throws IOException

Merge comments from the comment mapper with lines from the source.

The result is written to the writer.

Throws:

IOException - if any problem arise while reading or writing

readLine

protected String readLine()
                   throws IOException

Specified by:

readLine in class YamlCommentReader

Throws:

IOException

processLine

protected void processLine()
                    throws IOException

Overrides:

processLine in class YamlCommentReader

Throws:

IOException

clearSection

protected void clearSection()

getCommentNode

public void getCommentNode(KeyTree.Node readerNode)

checkFirstListMapElement

protected void checkFirstListMapElement(KeyTree.Node commentNode,
 KeyTree.Node readerNode)

getNode

public KeyTree.Node getNode(String path)

Overrides:

getNode in class YamlCommentMapper

appendBlockComment

protected void appendBlockComment()
                           throws IOException

Throws:

IOException

appendBlockComment

protected void appendBlockComment(String comment)
                           throws IOException

Throws:

IOException

appendSideComment

protected void appendSideComment()
                          throws IOException

Throws:

IOException

appendSideCommentLiteral

protected void appendSideCommentLiteral(String sideComment)
                                 throws IOException

Throws:

IOException

readValue

protected void readValue()
                  throws IOException

Overrides:

readValue in class YamlCommentReader

Throws:

IOException

skipMultiline

protected void skipMultiline()
                      throws IOException

Throws:

IOException

readKeyMultiline

protected void readKeyMultiline(StringBuilder keyBuilder)
                         throws IOException

Overrides:

readKeyMultiline in class YamlCommentReader

Throws:

IOException

processMultiline

protected void processMultiline(boolean inQuoteBlock)
                         throws IOException

Overrides:

processMultiline in class YamlCommentReader

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException