Package nl.talsmasoftware.umldoclet.configuration

Enum TypeDisplay

java.lang.Object

java.lang.Enum<TypeDisplay>

nl.talsmasoftware.umldoclet.configuration.TypeDisplay

All Implemented Interfaces:

Serializable, Comparable<TypeDisplay>

public enum TypeDisplay
extends Enum<TypeDisplay>

How a type name is rendered in UML.

NONE

Omit the type

SIMPLE

Use the simple type name (without its containing package)

QUALIFIED

Use the qualified type name

QUALIFIED_GENERICS

Use the qualified type name, also for its generic types

Author:

Sjoerd Talsma

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Omit the type name.
QUALIFIED	Use the qualified type name.
QUALIFIED_GENERICS	Use the qualified type name, also for its generic type variables.
SIMPLE	Use the simple type name without the containing package.

Method Summary

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

Omit the type name.

SIMPLE

public static final TypeDisplay SIMPLE

Use the simple type name without the containing package.

QUALIFIED

public static final TypeDisplay QUALIFIED

Use the qualified type name.

QUALIFIED_GENERICS

public static final TypeDisplay QUALIFIED_GENERICS

Use the qualified type name, also for its generic type variables.

Method Details

values

public static TypeDisplay[] 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 TypeDisplay 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