Module bus.setting

Package org.miaixz.bus.setting.format

Class CommentFormatter

java.lang.Object

org.miaixz.bus.setting.format.AbstractFormatter<IniComment>

org.miaixz.bus.setting.format.CommentFormatter

All Implemented Interfaces:

ElementFormatter<IniComment>

public class CommentFormatter
extends AbstractFormatter<IniComment>

A formatter that parses a string value into an IniComment object.

Since:

Java 17+

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor	Description
CommentFormatter()	Constructs a CommentFormatter with the default starting character ('#').
CommentFormatter(char startChar)	Constructs a CommentFormatter with a specific starting character.

Method Summary

Modifier and Type	Method	Description
boolean	check(String value)	Checks if the given string value is a comment.
IniComment	format(String value, int line)	Formats a comment string into an IniComment object.

Methods inherited from class org.miaixz.bus.setting.format.AbstractFormatter

getCommentElementFormatter, setCommentElementFormatter

Methods inherited from class java.lang.Object

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

Constructor Details

CommentFormatter

public CommentFormatter(char startChar)

Constructs a CommentFormatter with a specific starting character.

Parameters:

startChar - The character that identifies a comment line.

CommentFormatter

public CommentFormatter()

Constructs a CommentFormatter with the default starting character ('#').

Method Details

format

public IniComment format(String value,
 int line)

Formats a comment string into an IniComment object.

Parameters:

value - The raw string line, including the starting comment character.

line - The line number in the original file.

Returns:

The parsed IniComment object.

check

public boolean check(String value)

Checks if the given string value is a comment.

Parameters:

value - The string to check.

Returns:

true if the string starts with the configured comment character.