org.netbeans.api.java.source

Enum Comment.Style

java.lang.Object

java.lang.Enum<Comment.Style>

org.netbeans.api.java.source.Comment.Style

All Implemented Interfaces:

Serializable, Comparable<Comment.Style>

Enclosing class:

Comment

public static enum Comment.Style
extends Enum<Comment.Style>

The set of different comment types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK A block comment.
JAVADOC A JavaDoc comment.
LINE A line (double-slash) comment.
WHITESPACE Whitespace TODO: not comment, but requested by another teams to preserve empty lines etc.

Method Summary

Methods

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

LINE

public static final Comment.Style LINE

A line (double-slash) comment.

BLOCK

public static final Comment.Style BLOCK

A block comment.

JAVADOC

public static final Comment.Style JAVADOC

A JavaDoc comment.

WHITESPACE

public static final Comment.Style WHITESPACE

Whitespace TODO: not comment, but requested by another teams to preserve empty lines etc.

Method Detail

values

public static Comment.Style[] 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.Style c : Comment.Style.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.Style 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