Package | Description |
---|---|
org.simpleyaml.configuration.comments.format | |
org.simpleyaml.configuration.file |
Modifier and Type | Class and Description |
---|---|
class |
BlankLineYamlCommentFormatter
YamlCommentFormat.BLANK_LINE formatter |
class |
PrettyYamlCommentFormatter
YamlCommentFormat.PRETTY formatter |
Modifier and Type | Method and Description |
---|---|
YamlCommentFormatter |
YamlCommentFormat.commentFormatter() |
YamlCommentFormatter |
YamlCommentFormat.YamlCommentFormatterFactory.commentFormatter() |
YamlCommentFormatter |
YamlCommentFormatter.stripPrefix(boolean strip)
Set if stripping the prefix is desired.
|
YamlCommentFormatter |
YamlCommentFormatter.trim(boolean trim)
Set if leading and trailing spaces and blank lines at the beginning and end of the comments should be stripped away.
|
Modifier and Type | Method and Description |
---|---|
YamlCommentFormatter |
YamlConfigurationOptions.commentFormatter()
Gets the comment formatter used to format comments.
|
Modifier and Type | Method and Description |
---|---|
YamlFileWrapper |
YamlFileWrapper.comment(String comment,
YamlCommentFormatter yamlCommentFormatter)
Set a block comment to the section or value selected by path.
|
YamlConfigurationOptions |
YamlConfigurationOptions.commentFormatter(YamlCommentFormatter commentFormatter)
Sets the comment formatter to be used to format comments.
|
YamlFileWrapper |
YamlFileWrapper.commentSide(String comment,
YamlCommentFormatter yamlCommentFormatter)
Set a side comment to the section or value selected by path.
|
String |
YamlFile.getComment(String path,
CommentType type,
YamlCommentFormatter yamlCommentFormatter)
Retrieve the comment of the section or value selected by path.
|
String |
YamlFile.getComment(String path,
YamlCommentFormatter yamlCommentFormatter)
Retrieve the block comment of the section or value selected by path.
|
void |
YamlFile.setComment(String path,
String comment,
CommentType type,
YamlCommentFormatter yamlCommentFormatter)
Set a comment to the section or value selected by path.
|
void |
YamlFile.setComment(String path,
String comment,
YamlCommentFormatter yamlCommentFormatter)
Set a block comment to the section or value selected by path.
|
void |
YamlFile.setCommentFormat(YamlCommentFormatter yamlCommentFormatter)
Change the comment formatter for parsing and dumping comments.
|
Copyright © 2023. All rights reserved.