com.canto.cumulus.prefs

Enum CropTemplate.Type

java.lang.Object

java.lang.Enum<CropTemplate.Type>

com.canto.cumulus.prefs.CropTemplate.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CropTemplate.Type>

Enclosing class:

CropTemplate

public static enum CropTemplate.Type
extends java.lang.Enum<CropTemplate.Type>

The type of crop template. A manual crop template defines constraints and sizes for a crop area and output size selected by the user. A focus area crop template only defines the orientation of the focus area and the output size. The crop area is typically automatically determined.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TYPE_FOCUS_AREA The type of a focus area crop template.
TYPE_MANUAL The type of a manual crop template.

Method Summary

Methods

Modifier and Type	Method and Description
static CropTemplate.Type	find(int id) Return a crop template type enum value by ID.
int	getID()
static CropTemplate.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CropTemplate.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TYPE_MANUAL

public static final CropTemplate.Type TYPE_MANUAL

The type of a manual crop template.

TYPE_FOCUS_AREA

public static final CropTemplate.Type TYPE_FOCUS_AREA

The type of a focus area crop template.

Method Detail

values

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

Returns:

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

valueOf

public static CropTemplate.Type valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getID

public int getID()

find

public static CropTemplate.Type find(int id)

Return a crop template type enum value by ID.

Parameters:

id - The internal ID of the type value

Returns:

The type enum value or {null} if not found