com.canto.cumulus.prefs

Enum CropTemplate.Constraint

java.lang.Object

java.lang.Enum<CropTemplate.Constraint>

com.canto.cumulus.prefs.CropTemplate.Constraint

All Implemented Interfaces:

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

Enclosing class:

CropTemplate

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

The cropping constraints. The user has to crop either keeping a given aspect ration, a given fixed pixel size or can freely choose the crop area.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASPECT_RATIO The crop area needs to have a given aspect ratio.
CUSTOM The crop area can be of any size.
FIXED_SIZE The crop area needs to be of a given fixed pixel size.

Method Summary

Methods

Modifier and Type	Method and Description
static CropTemplate.Constraint	find(int id) Return a constraint enum value by ID.
static CropTemplate.Constraint	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CropTemplate.Constraint[]	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

ASPECT_RATIO

public static final CropTemplate.Constraint ASPECT_RATIO

The crop area needs to have a given aspect ratio. The ratio values are obtained separately.

FIXED_SIZE

public static final CropTemplate.Constraint FIXED_SIZE

The crop area needs to be of a given fixed pixel size. The fixed size value is obtained separately.

CUSTOM

public static final CropTemplate.Constraint CUSTOM

The crop area can be of any size.

Method Detail

values

public static CropTemplate.Constraint[] 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.Constraint c : CropTemplate.Constraint.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.Constraint 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

find

public static CropTemplate.Constraint find(int id)

Return a constraint enum value by ID.

Parameters:

id - The internal ID of the constraint value

Returns:

The constraint enum value or {null} if not found