net.talvi.puffinplot.data

Enum FileType

java.lang.Object

java.lang.Enum<FileType>

net.talvi.puffinplot.data.FileType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileType>

public enum FileType
extends java.lang.Enum<FileType>

The fields of this enum represent the types of file that PuffinPlot can read.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALTECH SAM, Caltech (a.k.a.
CUSTOM_TABULAR Custom tabular, defined by a FileFormat
DIRECTIONS Sample-level directional data
IAPD DAT, [Super-]IAPD[2000] (Torsvik et al.)
JR6 JR6 format used by AGICO software
PMD_ENKIN Textual PMD format originated by R.
PUFFINPLOT_NEW PPL, new PuffinPlot file format
PUFFINPLOT_OLD PPL, old PuffinPlot file format
TWOGEE DAT, 2G Long Core software
UCDAVIS Ancient UC Davis 2G format
UNKNOWN Unknown file format
ZPLOT TXT, Steve Hurst's Zplot program

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNiceName() Returns a user-friendly name for this filetype.
int	getShortcut()
static FileType	guess(java.io.File file) Attempts to guess the type of a file from its name and contents.
static FileType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FileType[]	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

TWOGEE

public static final FileType TWOGEE

DAT, 2G Long Core software

ZPLOT

public static final FileType ZPLOT

TXT, Steve Hurst's Zplot program

PUFFINPLOT_OLD

public static final FileType PUFFINPLOT_OLD

PPL, old PuffinPlot file format

PUFFINPLOT_NEW

public static final FileType PUFFINPLOT_NEW

PPL, new PuffinPlot file format

CALTECH

public static final FileType CALTECH

SAM, Caltech (a.k.a. CIT)

IAPD

public static final FileType IAPD

DAT, [Super-]IAPD[2000] (Torsvik et al.)

UCDAVIS

public static final FileType UCDAVIS

Ancient UC Davis 2G format

DIRECTIONS

public static final FileType DIRECTIONS

Sample-level directional data

CUSTOM_TABULAR

public static final FileType CUSTOM_TABULAR

Custom tabular, defined by a FileFormat

PMD_ENKIN

public static final FileType PMD_ENKIN

Textual PMD format originated by R. Enkin

JR6

public static final FileType JR6

JR6 format used by AGICO software

UNKNOWN

public static final FileType UNKNOWN

Unknown file format

Method Detail

values

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

Returns:

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

valueOf

public static FileType 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

guess

public static FileType guess(java.io.File file)
                      throws java.io.IOException

Attempts to guess the type of a file from its name and contents.

Parameters:

file - the file for which to guess the type

Returns:

the type of the file; UNKNOWN if it could not be guessed

Throws:

java.io.IOException - if an I/O error occurred

getNiceName

public java.lang.String getNiceName()

Returns a user-friendly name for this filetype. The returned string is suitable for display in a user interface.

Returns:

the name of this filetype

getShortcut

public int getShortcut()

Returns:

a character code representing a suggested keyboard shortcut for this filetype