net.talvi.puffinplot.data

Enum CoreSections.TargetDeclinationType

java.lang.Object

java.lang.Enum<CoreSections.TargetDeclinationType>

net.talvi.puffinplot.data.CoreSections.TargetDeclinationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CoreSections.TargetDeclinationType>

Enclosing class:

CoreSections

public static enum CoreSections.TargetDeclinationType
extends java.lang.Enum<CoreSections.TargetDeclinationType>

The declination which should be aligned with a reference alignment passed to {@link #alignSections(int, double, net.talvi.puffinplot.data.CoreSections.ReferenceAlignmentType) ).

Enum Constant Summary

Enum Constants

Enum Constant and Description
MEAN Align mean declination to reference declination.
TOP Align top declination to reference declination.

Method Summary

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

TOP

public static final CoreSections.TargetDeclinationType TOP

Align top declination to reference declination.

MEAN

public static final CoreSections.TargetDeclinationType MEAN

Align mean declination to reference declination.

Method Detail

values

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

Returns:

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

valueOf

public static CoreSections.TargetDeclinationType 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

getNiceName

public java.lang.String getNiceName()