com.electronwill.nightconfig.core

Class AbstractCommentedConfig.CommentedEntryWrapper

java.lang.Object

com.electronwill.nightconfig.core.AbstractConfig.EntryWrapper

com.electronwill.nightconfig.core.AbstractCommentedConfig.CommentedEntryWrapper

All Implemented Interfaces:

CommentedConfig.Entry, Config.Entry, UnmodifiableCommentedConfig.Entry, UnmodifiableConfig.Entry

Enclosing class:

AbstractCommentedConfig

protected class AbstractCommentedConfig.CommentedEntryWrapper
extends AbstractConfig.EntryWrapper
implements CommentedConfig.Entry

Field Summary

Fields inherited from class com.electronwill.nightconfig.core.AbstractConfig.EntryWrapper

mapEntry

Constructor Summary

Constructors

Constructor and Description
CommentedEntryWrapper(java.util.Map.Entry<java.lang.String,java.lang.Object> mapEntry)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getComment()
protected java.util.List<java.lang.String>	getPath()
int	hashCode()
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 class com.electronwill.nightconfig.core.AbstractConfig.EntryWrapper

getKey, getRawValue, setValue

Methods inherited from class java.lang.Object

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

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

setValue

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

Constructor Detail

CommentedEntryWrapper

public CommentedEntryWrapper(java.util.Map.Entry<java.lang.String,java.lang.Object> mapEntry)

Method Detail

getPath

protected java.util.List<java.lang.String> getPath()

getComment

public java.lang.String getComment()

Specified by:

getComment in interface UnmodifiableCommentedConfig.Entry

Returns:

the entry's comment, may contain several lines

setComment

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

Description copied from interface: CommentedConfig.Entry

Sets the entry's comment.

Specified by:

setComment in interface CommentedConfig.Entry

Parameters:

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

Returns:

the previous comment, or null if none.

removeComment

public java.lang.String removeComment()

Description copied from interface: CommentedConfig.Entry

Removes the entry's comment.

Specified by:

removeComment in interface CommentedConfig.Entry

Returns:

the previous comment, or null if none.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractConfig.EntryWrapper

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractConfig.EntryWrapper