Package ninja.leaping.configurate.loader
Enum CommentHandlers
- All Implemented Interfaces:
Serializable
,Comparable<CommentHandlers>
,java.lang.constant.Constable
,CommentHandler
public enum CommentHandlers extends Enum<CommentHandlers> implements CommentHandler
Defines a number of default
CommentHandler
s.-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description DOUBLE_SLASH
CommentHandler
for comments prefixed by a//
escape.HASH
CommentHandler
for comments prefixed by the#
character.SLASH_BLOCK
CommentHandler
for comments delineated using/* *\
.XML_STYLE
CommentHandler
for comments delineated using<!-- -->
. -
Method Summary
Modifier and Type Method Description static @Nullable String
extractComment(@NonNull BufferedReader reader, @NonNull CommentHandler... allowedHeaderTypes)
Uses provided comment handlers to extract a comment from the reader.@NonNull Optional<String>
extractHeader(@NonNull BufferedReader reader)
Defines the handlers behaviour for reading comments.@NonNull Collection<String>
toComment(@NonNull Collection<String> lines)
Converts the given lines into a commentstatic CommentHandlers
valueOf(String name)
Returns the enum constant of this type with the specified name.static CommentHandlers[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
HASH
CommentHandler
for comments prefixed by the#
character. -
DOUBLE_SLASH
CommentHandler
for comments prefixed by a//
escape. -
SLASH_BLOCK
CommentHandler
for comments delineated using/* *\
. -
XML_STYLE
CommentHandler
for comments delineated using<!-- -->
.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
extractHeader
Description copied from interface:CommentHandler
Defines the handlers behaviour for reading comments.- Specified by:
extractHeader
in interfaceCommentHandler
- Parameters:
reader
- The reader- Returns:
- The comment
- Throws:
IOException
- If any IO error occurs in the process
-
toComment
Description copied from interface:CommentHandler
Converts the given lines into a comment- Specified by:
toComment
in interfaceCommentHandler
- Parameters:
lines
- The lines to make a comment- Returns:
- The transformed lines
-
extractComment
public static @Nullable String extractComment(@NonNull BufferedReader reader, @NonNull CommentHandler... allowedHeaderTypes) throws IOExceptionUses provided comment handlers to extract a comment from the reader.- Parameters:
reader
- The readerallowedHeaderTypes
- The handlers to try- Returns:
- The extracted comment, or null if a comment could not be extracted
- Throws:
IOException
- If an IO error occurs
-