org.simpleyaml.configuration.comments.format

Interface CommentFormatter

All Known Implementing Classes:

BlankLineYamlCommentFormatter, PrettyYamlCommentFormatter, YamlCommentFormatter, YamlHeaderFormatter

public interface CommentFormatter

Converts a comment between a raw-format meant to be read by computers to a human-format meant to be read by humans and vice versa.

Method Summary

Modifier and Type	Method and Description
default String	dump(String comment)
default String	dump(String comment, CommentType type)
String	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	format(int indent, String comment, CommentType type, CommentFormatterConfiguration configuration)
static String	format(int indent, String prefixFirst, String prefixMultiline, String comment, CommentType type, String suffixMultiline, String suffixLast)
static String	format(String prefixFirst, String prefixMultiline, String comment, String suffixMultiline, String suffixLast)
default String	parse(Reader raw)
default String	parse(Reader raw, CommentType type)
String	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	parse(String raw)
default String	parse(String raw, CommentType type)
default String	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.

Method Detail

parse

String parse(Reader raw,
             CommentType type,
             KeyTree.Node node)
      throws IOException

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.

Parameters:

raw - the comment to parse that may contain special format characters with leading and trailing space

type - the comment type

node - the comment node

Returns:

the comment in the expected format to be read by humans

Throws:

IOException - if comment cannot be parsed

dump

String dump(String comment,
            CommentType type,
            KeyTree.Node node)

Given a comment returns the raw-formatted string to be dumped somewhere like a file.

Parameters:

comment - the comment to be dumped

type - the comment type

node - the comment node

Returns:

the raw-formatted comment string to be dumped, for instance to a configuration file

parse

default String parse(String raw,
                     CommentType type,
                     KeyTree.Node node)
              throws IOException

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.

Parameters:

raw - the comment to parse that may contain special format characters with leading and trailing space

type - the comment type

node - the comment node

Returns:

the comment in the expected format to be read by humans

Throws:

IOException

parse

default String parse(Reader raw,
                     CommentType type)
              throws IOException

Throws:

IOException

parse

default String parse(String raw,
                     CommentType type)
              throws IOException

Throws:

IOException

parse

default String parse(Reader raw)
              throws IOException

Throws:

IOException

parse

default String parse(String raw)
              throws IOException

Throws:

IOException

dump

default String dump(String comment,
                    CommentType type)

dump

default String dump(String comment)

format

static String format(int indent,
                     String prefixFirst,
                     String prefixMultiline,
                     String comment,
                     CommentType type,
                     String suffixMultiline,
                     String suffixLast)

format

static String format(String prefixFirst,
                     String prefixMultiline,
                     String comment,
                     String suffixMultiline,
                     String suffixLast)

format

static String format(int indent,
                     String comment,
                     CommentType type,
                     CommentFormatterConfiguration configuration)