Package noaa.coastwatch.gui

Enum Class IconFactory.Purpose

java.lang.Object

java.lang.Enum<IconFactory.Purpose>

noaa.coastwatch.gui.IconFactory.Purpose

All Implemented Interfaces:

Serializable, Comparable<IconFactory.Purpose>, java.lang.constant.Constable

Enclosing class:

IconFactory

public static enum IconFactory.Purpose
extends Enum<IconFactory.Purpose>

The purpose constants for the icon rendering.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSE_CIRCLE
CLOSE_ROUNDED
CLOSE_SQUARE
SEPARATOR_HORIZONTAL
SEPARATOR_VERTICAL

Method Summary

Modifier and Type	Method	Description
static IconFactory.Purpose	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IconFactory.Purpose[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLOSE_SQUARE

public static final IconFactory.Purpose CLOSE_SQUARE

CLOSE_ROUNDED

public static final IconFactory.Purpose CLOSE_ROUNDED

CLOSE_CIRCLE

public static final IconFactory.Purpose CLOSE_CIRCLE

SEPARATOR_VERTICAL

public static final IconFactory.Purpose SEPARATOR_VERTICAL

SEPARATOR_HORIZONTAL

public static final IconFactory.Purpose SEPARATOR_HORIZONTAL

Method Details

values

public static IconFactory.Purpose[] values()

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

Returns:

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

valueOf

public static IconFactory.Purpose valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null