com.sharkysoft.fig.core

Enum DetailLevel

java.lang.Object

java.lang.Enum<DetailLevel>

com.sharkysoft.fig.core.DetailLevel

All Implemented Interfaces:

Serializable, Comparable<DetailLevel>

public enum DetailLevel
extends Enum<DetailLevel>

Enumerates detail levels.

Details: DetailLevel is an enumeration of possible choices for the level of detail at which a figure can be rendered. Different levels of detail are defined to control the processing costs of rendering.

Author:

Sharky

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOXES Render as bounding box.
HOLLOW Render as wire frame.
NORMAL Render normally.

Method Summary

Methods

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

NORMAL

public static final DetailLevel NORMAL

Render normally.

Details: NORMAL indicates that the figure will be rendered at the normal level of detail.

HOLLOW

public static final DetailLevel HOLLOW

Render as wire frame.

Details: HOLLOW indicates that the figure will be rendered as a hollow wire frame.

BOXES

public static final DetailLevel BOXES

Render as bounding box.

Details: BOXES indicates that the figure will be rendered as a rectangular bounding box, normal to the X and Y axes.

Method Detail

values

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

Returns:

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

valueOf

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