spoon.reflect.code

Enum CtJavaDocTag.TagType

java.lang.Object

java.lang.Enum<CtJavaDocTag.TagType>

spoon.reflect.code.CtJavaDocTag.TagType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CtJavaDocTag.TagType>

Enclosing interface:

CtJavaDocTag

public static enum CtJavaDocTag.TagType
extends java.lang.Enum<CtJavaDocTag.TagType>

Define the possible type for a tag

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHOR
DEPRECATED
EXCEPTION
PARAM
RETURN
SEE
SERIAL
SERIAL_DATA
SERIAL_FIELD
SINCE
THROWS
UNKNOWN
VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get tag name
boolean	hasParam() Return true if the tag can have a parameter
static CtJavaDocTag.TagType	tagFromName(java.lang.String tagName) Get the tag type associated to a name
java.lang.String	toString()
static CtJavaDocTag.TagType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CtJavaDocTag.TagType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTHOR

public static final CtJavaDocTag.TagType AUTHOR

DEPRECATED

public static final CtJavaDocTag.TagType DEPRECATED

EXCEPTION

public static final CtJavaDocTag.TagType EXCEPTION

PARAM

public static final CtJavaDocTag.TagType PARAM

RETURN

public static final CtJavaDocTag.TagType RETURN

SEE

public static final CtJavaDocTag.TagType SEE

SERIAL

public static final CtJavaDocTag.TagType SERIAL

SERIAL_DATA

public static final CtJavaDocTag.TagType SERIAL_DATA

SERIAL_FIELD

public static final CtJavaDocTag.TagType SERIAL_FIELD

SINCE

public static final CtJavaDocTag.TagType SINCE

THROWS

public static final CtJavaDocTag.TagType THROWS

VERSION

public static final CtJavaDocTag.TagType VERSION

UNKNOWN

public static final CtJavaDocTag.TagType UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static CtJavaDocTag.TagType 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

getName

public java.lang.String getName()

Get tag name

Returns:

name

hasParam

public boolean hasParam()

Return true if the tag can have a parameter

Returns:

true if the tag can have a parameter

tagFromName

public static CtJavaDocTag.TagType tagFromName(java.lang.String tagName)

Get the tag type associated to a name

Parameters:

tagName - the tag name

Returns:

the tag type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<CtJavaDocTag.TagType>