org.simpleyaml.configuration.comments.format

Class PrettyYamlCommentFormatter

java.lang.Object

org.simpleyaml.configuration.comments.format.YamlCommentFormatter

org.simpleyaml.configuration.comments.format.PrettyYamlCommentFormatter

All Implemented Interfaces:

CommentFormatter

public class PrettyYamlCommentFormatter
extends YamlCommentFormatter

YamlCommentFormat.PRETTY formatter

Field Summary

Fields inherited from class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

blockFormatter, sideFormatter

Constructor Summary

Constructors

Constructor and Description
PrettyYamlCommentFormatter()
PrettyYamlCommentFormatter(YamlCommentFormatterConfiguration blockFormatter)
PrettyYamlCommentFormatter(YamlCommentFormatterConfiguration blockFormatter, YamlSideCommentFormatterConfiguration sideFormatter)

Method Summary

Modifier and Type	Method and Description
String	dump(String comment, CommentType type, KeyTree.Node node) Given a comment returns the raw-formatted string to be dumped somewhere like a file.

Methods inherited from class org.simpleyaml.configuration.comments.format.YamlCommentFormatter

blockFormatter, equals, formatterConfiguration, hashCode, parse, parseCommentLine, sideFormatter, stripPrefix, toString, trim

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.simpleyaml.configuration.comments.format.CommentFormatter

dump, dump, format, format, format, parse, parse, parse, parse, parse

Constructor Detail

PrettyYamlCommentFormatter

public PrettyYamlCommentFormatter()

PrettyYamlCommentFormatter

public PrettyYamlCommentFormatter(YamlCommentFormatterConfiguration blockFormatter)

PrettyYamlCommentFormatter

public PrettyYamlCommentFormatter(YamlCommentFormatterConfiguration blockFormatter,
                                  YamlSideCommentFormatterConfiguration sideFormatter)

Method Detail

dump

public String dump(String comment,
                   CommentType type,
                   KeyTree.Node node)

Description copied from interface: CommentFormatter

Given a comment returns the raw-formatted string to be dumped somewhere like a file.

Specified by:

dump in interface CommentFormatter

Overrides:

dump in class YamlCommentFormatter

Parameters:

comment - the comment to be dumped

type - the comment type

node - the comment node

Returns:

the raw-formatted comment string to be dumped, for instance to a configuration file