Package org.simpleyaml.configuration.comments

Class YamlCommentMapper

java.lang.Object

org.simpleyaml.configuration.comments.YamlCommentMapper

All Implemented Interfaces:

Commentable

Direct Known Subclasses:

SnakeYamlCommentMapper, YamlCommentReader

public class YamlCommentMapper
extends Object
implements Commentable

Field Summary

Fields

Modifier and Type	Field	Description
protected final KeyTree	keyTree
protected static final Predicate<KeyTree.Node>	NO_COMMENTS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlCommentMapper(YamlKeyTree keyTree)
	YamlCommentMapper(YamlConfigurationOptions options)

Method Summary

Modifier and Type	Method	Description
protected void	clearNode(KeyTree.Node node)
protected void	clearNodeIfNoComments(KeyTree.Node node)
String	getComment(String path, CommentType type)	Retrieve the comment of the section or value selected by path.
protected final String	getComment(KeyTree.Node node, CommentType type)
KeyTree	getKeyTree()
KeyTree.Node	getNode(String path)
protected KeyTree.Node	getOrAddNode(String path)
protected KeyTree.Node	getPriorityNode(String path)
String	getRawComment(String path, CommentType type)
protected final String	getRawComment(KeyTree.Node node, CommentType type)
protected YamlConfigurationOptions	options()
void	removeComment(String path, CommentType type)
protected final void	removeComment(KeyTree.Node node, CommentType type)
void	setComment(String path, String comment, CommentType type)	Set a comment to the section or value selected by path.
protected final void	setFormattedComment(KeyTree.Node node, String comment, CommentType type)
protected final void	setRawComment(KeyTree.Node node, String comment, CommentType type)

Methods inherited from class java.lang.Object

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

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

getComment, setComment

Field Details

keyTree

protected final KeyTree keyTree

NO_COMMENTS

protected static final Predicate<KeyTree.Node> NO_COMMENTS

Constructor Details

YamlCommentMapper

public YamlCommentMapper(YamlConfigurationOptions options)

YamlCommentMapper

protected YamlCommentMapper(YamlKeyTree keyTree)

Method Details

setComment

public void setComment(String path,
 String comment,
 CommentType type)

Description copied from interface: Commentable

Set a comment to the section or value selected by path. Comment will be indented automatically. Multi-line comments can be provided using \n character.

Specified by:

setComment in interface Commentable

Parameters:

path - path of desired section or key

comment - the comment to add, # symbol is not needed

type - either above (BLOCK) or SIDE

setFormattedComment

protected final void setFormattedComment(KeyTree.Node node,
 String comment,
 CommentType type)

setRawComment

protected final void setRawComment(KeyTree.Node node,
 String comment,
 CommentType type)

getComment

public String getComment(String path,
 CommentType type)

Description copied from interface: Commentable

Retrieve the comment of the section or value selected by path.

Specified by:

getComment in interface Commentable

Parameters:

path - path of desired section or key

type - either above (BLOCK) or SIDE

Returns:

the comment of the section or value selected by path, or null if that path does not have any comment of this type

getComment

protected final String getComment(KeyTree.Node node,
 CommentType type)

getRawComment

protected final String getRawComment(KeyTree.Node node,
 CommentType type)

getRawComment

public String getRawComment(String path,
 CommentType type)

removeComment

public void removeComment(String path,
 CommentType type)

removeComment

protected final void removeComment(KeyTree.Node node,
 CommentType type)

getKeyTree

public KeyTree getKeyTree()

options

protected YamlConfigurationOptions options()

getNode

public KeyTree.Node getNode(String path)

getPriorityNode

protected KeyTree.Node getPriorityNode(String path)

getOrAddNode

protected KeyTree.Node getOrAddNode(String path)

clearNodeIfNoComments

protected void clearNodeIfNoComments(KeyTree.Node node)

clearNode

protected void clearNode(KeyTree.Node node)