Package org.simpleyaml.configuration.comments.format

Class YamlCommentFormatterConfiguration

java.lang.Object

org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

org.simpleyaml.configuration.comments.format.YamlCommentFormatterConfiguration

Direct Known Subclasses:

YamlSideCommentFormatterConfiguration

public class YamlCommentFormatterConfiguration
extends org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMENT_INDICATOR
static final String	DEFAULT_COMMENT_PREFIX

Constructor Summary

Constructors

Constructor	Description
YamlCommentFormatterConfiguration()
YamlCommentFormatterConfiguration(String prefix)
YamlCommentFormatterConfiguration(String prefix, String prefixMultiline)

Method Summary

Modifier and Type	Method	Description
protected void	checkCommentPrefix(String commentPrefix)
protected void	checkCommentPrefixMultiline(String commentPrefix)
protected void	checkCommentSuffix(String commentSuffix)
protected void	checkCommentSuffixMultiline(String commentSuffix)
boolean	equals(Object o)
int	hashCode()
YamlCommentFormatterConfiguration	prefix(String prefix)
YamlCommentFormatterConfiguration	prefix(String prefixFirst, String prefixMultiline)
boolean	stripPrefix()
YamlCommentFormatterConfiguration	stripPrefix(boolean stripPrefix)
YamlCommentFormatterConfiguration	suffix(String suffixLast)
YamlCommentFormatterConfiguration	suffix(String suffixLast, String suffixMultiline)
String	toString()
boolean	trim()
YamlCommentFormatterConfiguration	trim(boolean 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 Details

COMMENT_INDICATOR

public static final String COMMENT_INDICATOR

See Also:

• Constant Field Values

DEFAULT_COMMENT_PREFIX

public static final String DEFAULT_COMMENT_PREFIX

See Also:

• Constant Field Values

Constructor Details

YamlCommentFormatterConfiguration

public YamlCommentFormatterConfiguration()

YamlCommentFormatterConfiguration

public YamlCommentFormatterConfiguration(String prefix)

YamlCommentFormatterConfiguration

public YamlCommentFormatterConfiguration(String prefix,
 String prefixMultiline)

Method Details

prefix

public YamlCommentFormatterConfiguration prefix(String prefix)

Overrides:

prefix in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

prefix

public YamlCommentFormatterConfiguration prefix(String prefixFirst,
 String prefixMultiline)

Overrides:

prefix in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

suffix

public YamlCommentFormatterConfiguration suffix(String suffixLast)

Overrides:

suffix in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

suffix

public YamlCommentFormatterConfiguration suffix(String suffixLast,
 String suffixMultiline)

Overrides:

suffix in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

stripPrefix

public YamlCommentFormatterConfiguration stripPrefix(boolean stripPrefix)

stripPrefix

public boolean stripPrefix()

trim

public YamlCommentFormatterConfiguration trim(boolean trim)

trim

public boolean trim()

checkCommentPrefix

protected void checkCommentPrefix(String commentPrefix)

checkCommentPrefixMultiline

protected void checkCommentPrefixMultiline(String commentPrefix)

checkCommentSuffix

protected void checkCommentSuffix(String commentSuffix)

checkCommentSuffixMultiline

protected void checkCommentSuffixMultiline(String commentSuffix)

equals

public boolean equals(Object o)

Overrides:

equals in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

hashCode

public int hashCode()

Overrides:

hashCode in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration

toString

public String toString()

Overrides:

toString in class org.simpleyaml.configuration.comments.format.CommentFormatterConfiguration