org.simpleyaml.configuration.comments.format

Class YamlSideCommentFormatterConfiguration

java.lang.Object

org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

org.simpleyaml.configuration.comments.format.YamlSideCommentFormatterConfiguration

public class YamlSideCommentFormatterConfiguration
extends YamlCommentFormatterConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SIDE_COMMENT_PREFIX

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

COMMENT_INDICATOR, DEFAULT_COMMENT_PREFIX

Constructor Summary

Constructors

Constructor and Description
YamlSideCommentFormatterConfiguration()
YamlSideCommentFormatterConfiguration(String sidePrefix)
YamlSideCommentFormatterConfiguration(String sidePrefix, String prefixMultiline)

Method Summary

Modifier and Type	Method and Description
protected void	checkCommentPrefix(String sidePrefix)
protected void	checkCommentPrefixMultiline(String commentPrefix)
YamlSideCommentFormatterConfiguration	prefix(String sidePrefix)
YamlSideCommentFormatterConfiguration	prefix(String prefixFirst, String prefixMultiline)
YamlSideCommentFormatterConfiguration	stripPrefix(boolean stripPrefix)
YamlSideCommentFormatterConfiguration	suffix(String suffixLast)
YamlSideCommentFormatterConfiguration	suffix(String suffixLast, String suffixMultiline)
YamlSideCommentFormatterConfiguration	trim(boolean trim)

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

checkCommentSuffix, checkCommentSuffixMultiline, equals, hashCode, stripPrefix, toString, trim

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

prefixFirst, prefixFirst, prefixMultiline, prefixMultiline, suffixLast, suffixLast, suffixMultiline, suffixMultiline

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIDE_COMMENT_PREFIX

public static final String DEFAULT_SIDE_COMMENT_PREFIX

See Also:

Constant Field Values

Constructor Detail

YamlSideCommentFormatterConfiguration

public YamlSideCommentFormatterConfiguration()

YamlSideCommentFormatterConfiguration

public YamlSideCommentFormatterConfiguration(String sidePrefix)

YamlSideCommentFormatterConfiguration

public YamlSideCommentFormatterConfiguration(String sidePrefix,
                                             String prefixMultiline)

Method Detail

prefix

public YamlSideCommentFormatterConfiguration prefix(String sidePrefix)

Overrides:

prefix in class YamlCommentFormatterConfiguration

prefix

public YamlSideCommentFormatterConfiguration prefix(String prefixFirst,
                                                    String prefixMultiline)

Overrides:

prefix in class YamlCommentFormatterConfiguration

suffix

public YamlSideCommentFormatterConfiguration suffix(String suffixLast)

Overrides:

suffix in class YamlCommentFormatterConfiguration

suffix

public YamlSideCommentFormatterConfiguration suffix(String suffixLast,
                                                    String suffixMultiline)

Overrides:

suffix in class YamlCommentFormatterConfiguration

trim

public YamlSideCommentFormatterConfiguration trim(boolean trim)

Overrides:

trim in class YamlCommentFormatterConfiguration

stripPrefix

public YamlSideCommentFormatterConfiguration stripPrefix(boolean stripPrefix)

Overrides:

stripPrefix in class YamlCommentFormatterConfiguration

checkCommentPrefix

protected void checkCommentPrefix(String sidePrefix)

Overrides:

checkCommentPrefix in class YamlCommentFormatterConfiguration

checkCommentPrefixMultiline

protected void checkCommentPrefixMultiline(String commentPrefix)

Overrides:

checkCommentPrefixMultiline in class YamlCommentFormatterConfiguration