com.soebes.maven.plugins.doxygen

Enum DoxygenParameterType

java.lang.Object

java.lang.Enum<DoxygenParameterType>

com.soebes.maven.plugins.doxygen.DoxygenParameterType

All Implemented Interfaces:

Serializable, Comparable<DoxygenParameterType>

public enum DoxygenParameterType
extends Enum<DoxygenParameterType>

This will define the kinds of parameters which are existing in doxygen configuration file.

Author:

Karl Heinz Marbaise

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN An boolean value which is represented by 'YES' and 'NO' in the doxygen configuration.
INTEGER An integer values.
LITERAL A value as-it.
STRING A usual string value.
STRING_QUOTED A quoted string means a string value which is quoted by using dobule quotes.

Method Summary

Methods

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

LITERAL

public static final DoxygenParameterType LITERAL

A value as-it.

STRING

public static final DoxygenParameterType STRING

A usual string value.

STRING_QUOTED

public static final DoxygenParameterType STRING_QUOTED

A quoted string means a string value which is quoted by using dobule quotes.

INTEGER

public static final DoxygenParameterType INTEGER

An integer values.

BOOLEAN

public static final DoxygenParameterType BOOLEAN

An boolean value which is represented by 'YES' and 'NO' in the doxygen configuration.

Method Detail

values

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

Returns:

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

valueOf

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