org.yaml.snakeyaml.comments

Enum CommentType

java.lang.Object

java.lang.Enum<CommentType>

org.yaml.snakeyaml.comments.CommentType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommentType>

public enum CommentType
extends java.lang.Enum<CommentType>

The type of a comment line.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLANK_LINE
BLOCK
IN_LINE

Method Summary

Modifier and Type	Method and Description
static CommentType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommentType[]	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

BLANK_LINE

public static final CommentType BLANK_LINE

BLOCK

public static final CommentType BLOCK

IN_LINE

public static final CommentType IN_LINE

Method Detail

values

public static CommentType[] 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 (CommentType c : CommentType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommentType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null