Package com.electronwill.nightconfig.core.utils

Class CommentedConfigWrapper<C extends CommentedConfig>

java.lang.Object

com.electronwill.nightconfig.core.utils.UnmodifiableConfigWrapper<C>

com.electronwill.nightconfig.core.utils.ConfigWrapper<C>

com.electronwill.nightconfig.core.utils.CommentedConfigWrapper<C>

All Implemented Interfaces:

CommentedConfig, Config, UnmodifiableCommentedConfig, UnmodifiableConfig

public abstract class CommentedConfigWrapper<C extends CommentedConfig>
extends ConfigWrapper<C>
implements CommentedConfig

Nested Class Summary

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.CommentedConfig

CommentedConfig.Entry

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.Config

Config.Entry

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.UnmodifiableCommentedConfig

UnmodifiableCommentedConfig.CommentNode

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.UnmodifiableConfig

UnmodifiableConfig.Entry

Field Summary

Fields inherited from class com.electronwill.nightconfig.core.utils.UnmodifiableConfigWrapper

config

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommentedConfigWrapper(C config)

Method Summary

Modifier and Type	Method	Description
void	clearComments()	Removes all the comments from the config.
java.util.Map<java.lang.String,java.lang.String>	commentMap()	Returns a Map view of the config's comments.
boolean	containsComment(java.util.List<java.lang.String> path)	Checks if the config contains a comment at some path.
CommentedConfig	createSubConfig()	Creates a new sub config of this config, as created when a subconfig's creation is implied by Config.set(List, Object) or Config.add(List, Object).
java.util.Set<? extends CommentedConfig.Entry>	entrySet()	Returns a Set view of the config's entries.
java.lang.String	getComment(java.util.List<java.lang.String> path)	Gets a comment from the config.
java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode>	getComments()	Returns a Map containing a deep copy of all the comments in the config.
void	putAllComments(UnmodifiableCommentedConfig commentedConfig)	Puts the comments in the given config to this config.
void	putAllComments(java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> comments)	Puts the comments in the given map to this config.
java.lang.String	removeComment(java.util.List<java.lang.String> path)	Removes a comment from the config.
java.lang.String	setComment(java.util.List<java.lang.String> path, java.lang.String comment)	Sets a config comment.
java.lang.String	toString()

Methods inherited from class com.electronwill.nightconfig.core.utils.ConfigWrapper

add, clear, remove, set

Methods inherited from class com.electronwill.nightconfig.core.utils.UnmodifiableConfigWrapper

configFormat, contains, equals, getRaw, hashCode, isEmpty, size, valueMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.electronwill.nightconfig.core.CommentedConfig

checked, removeComment, setComment, unmodifiable

Methods inherited from interface com.electronwill.nightconfig.core.Config

add, add, addAll, clear, putAll, remove, remove, removeAll, set, set, update, update, valueMap

Methods inherited from interface com.electronwill.nightconfig.core.UnmodifiableCommentedConfig

containsComment, getComment, getComments, getOptionalComment, getOptionalComment

Methods inherited from interface com.electronwill.nightconfig.core.UnmodifiableConfig

apply, apply, configFormat, contains, contains, get, get, getByte, getByte, getByteOrElse, getByteOrElse, getChar, getChar, getCharOrElse, getCharOrElse, getEnum, getEnum, getEnum, getEnum, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getInt, getInt, getIntOrElse, getIntOrElse, getIntOrElse, getIntOrElse, getLong, getLong, getLongOrElse, getLongOrElse, getLongOrElse, getLongOrElse, getOptional, getOptional, getOptionalEnum, getOptionalEnum, getOptionalEnum, getOptionalEnum, getOptionalInt, getOptionalInt, getOptionalLong, getOptionalLong, getOrElse, getOrElse, getOrElse, getOrElse, getRaw, getRaw, getShort, getShort, getShortOrElse, getShortOrElse, isEmpty, isNull, isNull, size

Constructor Detail

CommentedConfigWrapper

protected CommentedConfigWrapper(C config)

Method Detail

getComment

public java.lang.String getComment(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableCommentedConfig

Gets a comment from the config.

Specified by:

getComment in interface UnmodifiableCommentedConfig

Parameters:

path - the comment's path, each element of the list is a different part of the path.

Returns:

the comment at the given path, or null if there is none.

containsComment

public boolean containsComment(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableCommentedConfig

Checks if the config contains a comment at some path.

Specified by:

containsComment in interface UnmodifiableCommentedConfig

Parameters:

path - the path to check, each element of the list is a different part of the path.

Returns:

true if the path is associated with a comment, false if it's not.

setComment

public java.lang.String setComment(java.util.List<java.lang.String> path,
                                   java.lang.String comment)

Description copied from interface: CommentedConfig

Sets a config comment.

Specified by:

setComment in interface CommentedConfig

Parameters:

path - the comment's path, each element of the list is a different part of the path.

comment - the comment to set

Returns:

the old comment if any, or null

removeComment

public java.lang.String removeComment(java.util.List<java.lang.String> path)

Description copied from interface: CommentedConfig

Removes a comment from the config.

Specified by:

removeComment in interface CommentedConfig

Parameters:

path - the comment's path, each element of the list is a different part of the path.

Returns:

the old comment if any, or null

commentMap

public java.util.Map<java.lang.String,java.lang.String> commentMap()

Description copied from interface: CommentedConfig

Returns a Map view of the config's comments. Any change to the map is reflected in the config and vice-versa.

The comment map contains only the comments of the direct elements of the configuration, not the comments of their sub-elements.

Specified by:

commentMap in interface CommentedConfig

Specified by:

commentMap in interface UnmodifiableCommentedConfig

Returns:

a Map view of the config's comments.

entrySet

public java.util.Set<? extends CommentedConfig.Entry> entrySet()

Description copied from interface: UnmodifiableConfig

Returns a Set view of the config's entries. If the config is unmodifiable then the returned set is unmodifiable too.

Specified by:

entrySet in interface CommentedConfig

Specified by:

entrySet in interface Config

Specified by:

entrySet in interface UnmodifiableCommentedConfig

Specified by:

entrySet in interface UnmodifiableConfig

Overrides:

entrySet in class ConfigWrapper<C extends CommentedConfig>

Returns:

a Set view of the config's entries.

clearComments

public void clearComments()

Description copied from interface: CommentedConfig

Removes all the comments from the config.

Specified by:

clearComments in interface CommentedConfig

putAllComments

public void putAllComments(java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> comments)

Description copied from interface: CommentedConfig

Puts the comments in the given map to this config. Existing comments are replaced, missing comments are created.

Specified by:

putAllComments in interface CommentedConfig

Parameters:

comments - the comments to set

putAllComments

public void putAllComments(UnmodifiableCommentedConfig commentedConfig)

Description copied from interface: CommentedConfig

Puts the comments in the given config to this config. Existing comments are replaced, missing comments are created.

Specified by:

putAllComments in interface CommentedConfig

Parameters:

commentedConfig - the config to copy its comments

getComments

public java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> getComments()

Description copied from interface: UnmodifiableCommentedConfig

Returns a Map containing a deep copy of all the comments in the config.

Specified by:

getComments in interface UnmodifiableCommentedConfig

Returns:

a Map containing the comments in the config.

createSubConfig

public CommentedConfig createSubConfig()

Description copied from interface: Config

Creates a new sub config of this config, as created when a subconfig's creation is implied by Config.set(List, Object) or Config.add(List, Object).

Specified by:

createSubConfig in interface CommentedConfig

Specified by:

createSubConfig in interface Config

Overrides:

createSubConfig in class ConfigWrapper<C extends CommentedConfig>

Returns:

a new sub config

toString

public java.lang.String toString()

Overrides:

toString in class ConfigWrapper<C extends CommentedConfig>