Modifier and Type | Method and Description |
---|---|
static CommentType |
CommentType.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static CommentType[] |
CommentType.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Modifier and Type | Method and Description |
---|---|
protected String |
YamlCommentMapper.getComment(KeyTree.Node node,
CommentType type) |
String |
YamlCommentMapper.getComment(String path,
CommentType type) |
String |
Commentable.getComment(String path,
CommentType type)
Retrieve the comment of the section or value selected by path.
|
protected String |
YamlCommentMapper.getRawComment(KeyTree.Node node,
CommentType type) |
String |
YamlCommentMapper.getRawComment(String path,
CommentType type) |
protected void |
YamlCommentMapper.removeComment(KeyTree.Node node,
CommentType type) |
void |
YamlCommentMapper.removeComment(String path,
CommentType type) |
void |
YamlCommentMapper.setComment(String path,
String comment,
CommentType type) |
void |
Commentable.setComment(String path,
String comment,
CommentType type)
Set a comment to the section or value selected by path.
|
protected void |
YamlCommentMapper.setFormattedComment(KeyTree.Node node,
String comment,
CommentType type) |
protected void |
YamlCommentMapper.setRawComment(KeyTree.Node node,
String comment,
CommentType type) |
Modifier and Type | Method and Description |
---|---|
default String |
CommentFormatter.dump(String comment,
CommentType type) |
String |
BlankLineYamlCommentFormatter.dump(String comment,
CommentType type,
KeyTree.Node node) |
String |
YamlHeaderFormatter.dump(String header,
CommentType type,
KeyTree.Node node)
Given the header (for instance the one returned by
YamlHeaderFormatter.parse(java.lang.String, org.simpleyaml.configuration.comments.CommentType, org.simpleyaml.configuration.comments.KeyTree.Node) ),
returns the final string formatted to be dumped somewhere like a file. |
String |
YamlCommentFormatter.dump(String comment,
CommentType type,
KeyTree.Node node) |
String |
PrettyYamlCommentFormatter.dump(String comment,
CommentType type,
KeyTree.Node node) |
String |
CommentFormatter.dump(String comment,
CommentType type,
KeyTree.Node node)
Given a comment returns the raw-formatted string to be dumped somewhere like a file.
|
static String |
CommentFormatter.format(int indent,
String comment,
CommentType type,
CommentFormatterConfiguration configuration) |
static String |
CommentFormatter.format(int indent,
String prefixFirst,
String prefixMultiline,
String comment,
CommentType type,
String suffixMultiline,
String suffixLast) |
YamlCommentFormatterConfiguration |
YamlCommentFormatter.formatterConfiguration(CommentType type) |
default String |
CommentFormatter.parse(Reader raw,
CommentType type) |
String |
YamlHeaderFormatter.parse(Reader raw,
CommentType type,
KeyTree.Node node) |
String |
YamlCommentFormatter.parse(Reader raw,
CommentType type,
KeyTree.Node node) |
String |
CommentFormatter.parse(Reader raw,
CommentType type,
KeyTree.Node node)
Parse the comment from a reader that may contain a raw-formatted comment (for instance from a configuration file)
to a human-friendly contentful representation of that comment.
|
default String |
CommentFormatter.parse(String raw,
CommentType type) |
String |
YamlHeaderFormatter.parse(String raw,
CommentType type,
KeyTree.Node node)
Parse the header of a contents string, like a file contents.
|
default String |
CommentFormatter.parse(String raw,
CommentType type,
KeyTree.Node node)
Parse the comment from a string that may contain a raw-formatted comment (for instance from a configuration file)
to a human-friendly contentful representation of that comment.
|
Modifier and Type | Method and Description |
---|---|
String |
YamlFile.getComment(String path,
CommentType type)
Retrieve the comment of the section or value selected by path.
|
String |
YamlFile.getComment(String path,
CommentType type,
YamlCommentFormat yamlCommentFormat)
Retrieve the comment of 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.
|
void |
YamlFile.setComment(String path,
String comment,
CommentType type)
Set a comment to the section or value selected by path.
|
void |
YamlFile.setComment(String path,
String comment,
CommentType type,
YamlCommentFormat yamlCommentFormat)
Set a comment to 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.
|
Modifier and Type | Method and Description |
---|---|
void |
SimpleYamlImplementation.setComment(String path,
String comment,
CommentType type) |
Modifier and Type | Method and Description |
---|---|
String |
YamlImplementationCommentable.getComment(String path,
CommentType type) |
void |
YamlImplementationCommentable.setComment(String path,
String comment,
CommentType type) |
Modifier and Type | Method and Description |
---|---|
void |
SnakeYamlImplementation.setComment(String path,
String comment,
CommentType type) |
Copyright © 2023. All rights reserved.