ninja.leaping.configurate.loader

Enum CommentHandlers

java.lang.Object

java.lang.Enum<CommentHandlers>

ninja.leaping.configurate.loader.CommentHandlers

All Implemented Interfaces:

Serializable, Comparable<CommentHandlers>, CommentHandler

public enum CommentHandlers
extends Enum<CommentHandlers>
implements CommentHandler

Handlers for various comment formats

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOUBLE_SLASH
HASH
SLASH_BLOCK Block comments delineated by

Method Summary

Modifier and Type	Method and Description
static String	extractComment(BufferedReader reader, CommentHandler... allowedHeaderTypes)
Optional<String>	extractHeader(BufferedReader reader)
Collection<String>	toComment(Collection<String> lines) Convert the given lines into a comment
static 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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HASH

public static final CommentHandlers HASH

DOUBLE_SLASH

public static final CommentHandlers DOUBLE_SLASH

SLASH_BLOCK

public static final CommentHandlers SLASH_BLOCK

Block comments delineated by

Method Detail

values

public static CommentHandlers[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommentHandlers c : CommentHandlers.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommentHandlers valueOf(String name)

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 name

NullPointerException - if the argument is null

extractHeader

public Optional<String> extractHeader(BufferedReader reader)
                               throws IOException

Specified by:

extractHeader in interface CommentHandler

Throws:

IOException

toComment

public Collection<String> toComment(Collection<String> lines)

Description copied from interface: CommentHandler

Convert the given lines into a comment

Specified by:

toComment in interface CommentHandler

Parameters:

lines - The lines to make a comment

Returns:

The transformed lines

extractComment

public static String extractComment(BufferedReader reader,
                                    CommentHandler... allowedHeaderTypes)
                             throws IOException

Throws:

IOException