org.schmant.task.template.jdk.javadoc
Enum JavadocTagPlace

java.lang.Object
  java.lang.Enum<JavadocTagPlace>
      org.schmant.task.template.jdk.javadoc.JavadocTagPlace

All Implemented Interfaces:

Serializable, Comparable<JavadocTagPlace>

public enum JavadocTagPlace
extends Enum<JavadocTagPlace>

This is an enumeration over all places where a Javadoc tag may occur. See the JDK Javadoc documentation for more info.

Since:

0.6

Author:

Karl Gustafsson

See Also:

JavadocTagDefinition

Enum Constant Summary

CONSTRUCTORS
Indicates that the tag can be placed in the documentation for class constructors.

FIELDS
Indicates that the tag can be placed in the documentation of fields.

METHODS
Indicates that the tag can be placed in the documentation of methods.

OVERVIEW
Indicates that the tag can be placed in the overview documentation.

PACKAGES
Indicates that the tag can be placed in the package documentation.

TYPES
Indicates that the tag can be placed in the class or interface documentation.

Method Summary

char	getChar() Get the character identifying the tag place as defined in the Javadoc tool documentation.
static JavadocTagPlace	getFromChar(char c) Get the enumeration constant that represents the supplied tag place character.
String	getIdentifier() Get a textual description of the tag place.
String	toString()
static JavadocTagPlace	valueOf(String name) Returns the enum constant of this type with the specified name.
static JavadocTagPlace[]	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

OVERVIEW

public static final JavadocTagPlace OVERVIEW

Indicates that the tag can be placed in the overview documentation.

This corresponds to giving the -tag parameter the tag placement argument o.

PACKAGES

public static final JavadocTagPlace PACKAGES

Indicates that the tag can be placed in the package documentation.

This corresponds to giving the -tag parameter the tag placement argument p.

TYPES

public static final JavadocTagPlace TYPES

Indicates that the tag can be placed in the class or interface documentation.

This corresponds to giving the -tag parameter the tag placement argument t.

CONSTRUCTORS

public static final JavadocTagPlace CONSTRUCTORS

Indicates that the tag can be placed in the documentation for class constructors.

This corresponds to giving the -tag parameter the tag placement argument c.

METHODS

public static final JavadocTagPlace METHODS

Indicates that the tag can be placed in the documentation of methods.

This corresponds to giving the -tag parameter the tag placement argument m.

FIELDS

public static final JavadocTagPlace FIELDS

Indicates that the tag can be placed in the documentation of fields.

This corresponds to giving the -tag parameter the tag placement argument f.

Method Detail

values

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

Returns:

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

valueOf

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

getIdentifier

public String getIdentifier()

Get a textual description of the tag place.

Returns:

A textual description of the tag place.

getChar

public char getChar()

Get the character identifying the tag place as defined in the Javadoc tool documentation.

Returns:

The tag place char.

getFromChar

public static JavadocTagPlace getFromChar(char c)
                                   throws IllegalArgumentException

Get the enumeration constant that represents the supplied tag place character.

Parameters:

c - The tag place character. (As defined in the Javadoc documentation.)

Returns:

The JavadocTagPlace enumeration constant that corresponds to the supplied character.

Throws:

IllegalArgumentException - If the character does not correspond to a enumeration constant.

toString

public String toString()

Overrides:

toString in class Enum<JavadocTagPlace>