ch.jalu.configme.configurationdata

Class CommentsConfiguration

java.lang.Object

ch.jalu.configme.configurationdata.CommentsConfiguration

public class CommentsConfiguration
extends Object

Allows to register comments (intended via SettingsHolder.registerComments(ch.jalu.configme.configurationdata.CommentsConfiguration)).

Constructor Summary

Constructors

Constructor and Description
CommentsConfiguration() Constructor.
CommentsConfiguration(Map<String,List<String>> comments) Constructor.

Method Summary

Modifier and Type	Method and Description
Map<String,List<String>>	getAllComments() Returns a read-only view of the map with all comments.
void	setComment(String path, String... commentLines) Sets the given lines for the provided path, overriding any previously existing comments for the path.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentsConfiguration

public CommentsConfiguration()

Constructor.

CommentsConfiguration

public CommentsConfiguration(Map<String,List<String>> comments)

Constructor.

Parameters:

comments - map to store comments in

Method Detail

setComment

public void setComment(String path,
                       String... commentLines)

Sets the given lines for the provided path, overriding any previously existing comments for the path. An entry that is a sole new-line (i.e. "\n") will result in an empty line without any comment marker.

Parameters:

path - the path to register the comment lines for

commentLines - the comment lines to set for the path

getAllComments

public Map<String,List<String>> getAllComments()

Returns a read-only view of the map with all comments.

Returns:

map with all comments