Package spoon.reflect.code

Enum Class CtComment.CommentType

java.lang.Object

java.lang.Enum<CtComment.CommentType>

spoon.reflect.code.CtComment.CommentType

All Implemented Interfaces:

Serializable, Comparable<CtComment.CommentType>, Constable

Enclosing interface:

CtComment

public static enum CtComment.CommentType
extends Enum<CtComment.CommentType>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCK	Block comment (/* *\/)
FILE	before the package line (typically the license)
INLINE	Inline comment (//)
JAVADOC	JavaDoc comment: before methods, fields, types
MARKDOWN	Markdown documentation comment (///) (Java 23+, JEP 467).

Method Summary

Modifier and Type	Method	Description
static CtComment.CommentType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CtComment.CommentType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FILE

public static final CtComment.CommentType FILE

before the package line (typically the license)

JAVADOC

public static final CtComment.CommentType JAVADOC

JavaDoc comment: before methods, fields, types

INLINE

public static final CtComment.CommentType INLINE

Inline comment (//)

BLOCK

public static final CtComment.CommentType BLOCK

Block comment (/* *\/)

MARKDOWN

public static final CtComment.CommentType MARKDOWN

Markdown documentation comment (///) (Java 23+, JEP 467). Each line of a markdown comment starts with ///.

Method Details

values

public static CtComment.CommentType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CtComment.CommentType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null