Package nl.talsmasoftware.umldoclet.configuration

Enum MethodConfig.ParamNames

java.lang.Object

java.lang.Enum<MethodConfig.ParamNames>

nl.talsmasoftware.umldoclet.configuration.MethodConfig.ParamNames

All Implemented Interfaces:

Serializable, Comparable<MethodConfig.ParamNames>

Enclosing interface:

MethodConfig

public static enum MethodConfig.ParamNames
extends Enum<MethodConfig.ParamNames>

How method parameters are rendered.

NONE will omit the name for the parameter names, BEFORE_TYPE will render the name first, followed by the type, while AFTER_TYPE renders the type first followed by the parameter name (java-style).

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFTER_TYPE	Render the method parameter type first, followed by its name.
BEFORE_TYPE	Render the method parameter name first before its type.
NONE	Omit parameter names from methods altogether.

Method Summary

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

NONE

public static final MethodConfig.ParamNames NONE

Omit parameter names from methods altogether.

BEFORE_TYPE

public static final MethodConfig.ParamNames BEFORE_TYPE

Render the method parameter name first before its type.

AFTER_TYPE

public static final MethodConfig.ParamNames AFTER_TYPE

Render the method parameter type first, followed by its name.

Method Details

values

public static MethodConfig.ParamNames[] values()

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

Returns:

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

valueOf

public static MethodConfig.ParamNames 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