com.conveyal.gtfs.loader

Enum Requirement

java.lang.Object

java.lang.Enum<Requirement>

com.conveyal.gtfs.loader.Requirement

All Implemented Interfaces:

Serializable, Comparable<Requirement>

public enum Requirement
extends Enum<Requirement>

These are field requirement levels, which should be assigned accordingly to any fields within a Table to determine if a field is requisite for a specific purpose. TODO: These enum values should be placed in an ordered list or assigned order constants, which allow a generic filtering predicate that returns true for elements "up to and including" a supplied level. Currently, this has a fragmented implementation in Table.editorFields() and Table.specFields(). However, it is currently unclear what the levels.order for the types EXTENSION, PROPIETARY, and UNKNOWN ought to be.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDITOR
EXTENSION
OPTIONAL
PROPRIETARY
REQUIRED
UNKNOWN

Method Summary

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

REQUIRED

public static final Requirement REQUIRED

OPTIONAL

public static final Requirement OPTIONAL

EXTENSION

public static final Requirement EXTENSION

PROPRIETARY

public static final Requirement PROPRIETARY

UNKNOWN

public static final Requirement UNKNOWN

EDITOR

public static final Requirement EDITOR

Method Detail

values

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

Returns:

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

valueOf

public static Requirement valueOf(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:

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

NullPointerException - if the argument is null