Package org.aoju.bus.setting.magic

Interface IniComment

All Superinterfaces:

CharSequence, IniElement, Serializable

All Known Implementing Classes:

IniCommentImpl

public interface IniComment
extends IniElement

Ini file's comment.

Since:

Java 17+

Version:

6.5.0

Author:

Kimi Liu

Method Summary

Modifier and Type	Method	Description
default void	clearComment()	clear comment (if exists).
default IniComment	getComment()	there may be comments at the end of each element.
default String	toNoCommentString()	like IniElement.toString(), without comment value(if exists).

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, isEmpty, length, subSequence

Methods inherited from interface org.aoju.bus.setting.magic.IniElement

getCommentOptional, getOriginalValue, isComment, isProperty, isSection, line, setValue, setValue, toCompleteString, toString, value

Method Details

getComment

default IniComment getComment()

there may be comments at the end of each element. or null. if this element is comment, return itself. so, nullable, or see IniElement.getCommentOptional().

Specified by:

getComment in interface IniElement

Returns:

comment end of the element or null. if element, return itself.

See Also:

• IniElement.getCommentOptional()

clearComment

default void clearComment()

clear comment (if exists).

Specified by:

clearComment in interface IniElement

toNoCommentString

default String toNoCommentString()

like IniElement.toString(), without comment value(if exists). comment to no comment string? no, return original value.

Specified by:

toNoCommentString in interface IniElement

Returns:

to string value without comment value.