xtc.tree

Enum Comment.Kind

java.lang.Object

java.lang.Enum<Comment.Kind>

xtc.tree.Comment.Kind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Comment.Kind>

Enclosing class:

Comment

public static enum Comment.Kind
extends java.lang.Enum<Comment.Kind>

The kind of comment.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENTATION Documentation.
MULTIPLE_LINES Multiple lines.
SINGLE_LINE A single line.

Method Summary

Methods

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

SINGLE_LINE

public static final Comment.Kind SINGLE_LINE

A single line.

MULTIPLE_LINES

public static final Comment.Kind MULTIPLE_LINES

Multiple lines.

DOCUMENTATION

public static final Comment.Kind DOCUMENTATION

Documentation.

Method Detail

values

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

Returns:

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

valueOf

public static Comment.Kind 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