com.electronwill.nightconfig.core

Interface CommentedConfig.Entry

All Superinterfaces:

Config.Entry, UnmodifiableCommentedConfig.Entry, UnmodifiableConfig.Entry

All Known Implementing Classes:

AbstractCommentedConfig.CommentedEntryWrapper

Enclosing interface:

CommentedConfig

public static interface CommentedConfig.Entry
extends Config.Entry, UnmodifiableCommentedConfig.Entry

A modifiable commented config entry.

Method Summary

Modifier and Type	Method and Description
java.lang.String	removeComment() Removes the entry's comment.
java.lang.String	setComment(java.lang.String comment) Sets the entry's comment.

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

setValue

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

getComment

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

getByte, getByteOrElse, getChar, getCharOrElse, getInt, getIntOrElse, getKey, getLong, getLongOrElse, getOptional, getOptionalInt, getOptionalLong, getOrElse, getRawValue, getShort, getShortOrElse, getValue, isNull

Method Detail

setComment

java.lang.String setComment(java.lang.String comment)

Sets the entry's comment.

Parameters:

comment - the comment to set, may contain several lines.

Returns:

the previous comment, or null if none.

removeComment

java.lang.String removeComment()

Removes the entry's comment.

Returns:

the previous comment, or null if none.