org.fulib.scenarios.ast.sentence

Enum CommentLevel

java.lang.Object

java.lang.Enum<CommentLevel>

org.fulib.scenarios.ast.sentence.CommentLevel

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATEGORIES
CODE_SECTION
GENERATED
MEMBERS
REGULAR

Method Summary

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

GENERATED

public static final CommentLevel GENERATED

MEMBERS

public static final CommentLevel MEMBERS

CATEGORIES

public static final CommentLevel CATEGORIES

CODE_SECTION

public static final CommentLevel CODE_SECTION

REGULAR

public static final CommentLevel REGULAR

Method Detail

values

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

Returns:

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

valueOf

public static CommentLevel 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

getFormat

public java.lang.String getFormat()

format

public java.lang.String format(java.lang.String text)