Package org.anchoranalysis.image.bean.nonbean.spatial.align

Enum Class AlignmentOnDimension

Object

Enum<AlignmentOnDimension>

AlignmentOnDimension

All Implemented Interfaces:

Serializable, Comparable<AlignmentOnDimension>, Constable

public enum AlignmentOnDimension
extends Enum<AlignmentOnDimension>

How the alignment will occur for a particular dimension.

Author:

Owen Feehan

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
CENTER	Aligns to the center position along the axis.
MAX	Aligns to the maximum position along the axis.
MIN	Aligns to the minimum position along the axis.

Method Summary

Modifier and Type	Method	Description
abstract int	align(int larger, int smaller, int disconsiderLeft)	Determine the minimum value after alignment.
static AlignmentOnDimension	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AlignmentOnDimension[]	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

MIN

public static final AlignmentOnDimension MIN

Aligns to the minimum position along the axis.

CENTER

public static final AlignmentOnDimension CENTER

Aligns to the center position along the axis.

MAX

public static final AlignmentOnDimension MAX

Aligns to the maximum position along the axis.

Method Details

values

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

align

public abstract int align(int larger,
 int smaller,
 int disconsiderLeft)

Determine the minimum value after alignment.

Parameters:

larger - the larger space which is aligned with, disconsidering the first disconsiderLeft of it.

smaller - the smaller space to align.

disconsiderLeft - how much of larger to disconsider, left-most.

Returns:

the minimum value of the smaller space after alignment.