org.biojava.nbio.structure.io

Enum LocalPDBDirectory.ObsoleteBehavior

java.lang.Object

java.lang.Enum<LocalPDBDirectory.ObsoleteBehavior>

org.biojava.nbio.structure.io.LocalPDBDirectory.ObsoleteBehavior

All Implemented Interfaces:

Serializable, Comparable<LocalPDBDirectory.ObsoleteBehavior>

Enclosing class:

LocalPDBDirectory

public static enum LocalPDBDirectory.ObsoleteBehavior
extends Enum<LocalPDBDirectory.ObsoleteBehavior>

Behaviors for when an obsolete structure is requested.

Author:

Spencer Bliven

See Also:

LocalPDBDirectory.setObsoleteBehavior(ObsoleteBehavior)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FETCH_CURRENT Fetch the most recent version of the PDB entry.
FETCH_OBSOLETE Fetch the obsolete entry from the PDB archives.
THROW_EXCEPTION Throw a StructureException for obsolete entries.

Field Summary

Fields

Modifier and Type	Field and Description
static LocalPDBDirectory.ObsoleteBehavior	DEFAULT

Method Summary

Methods

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

FETCH_CURRENT

public static final LocalPDBDirectory.ObsoleteBehavior FETCH_CURRENT

Fetch the most recent version of the PDB entry.

FETCH_OBSOLETE

public static final LocalPDBDirectory.ObsoleteBehavior FETCH_OBSOLETE

Fetch the obsolete entry from the PDB archives.

THROW_EXCEPTION

public static final LocalPDBDirectory.ObsoleteBehavior THROW_EXCEPTION

Throw a StructureException for obsolete entries.

Field Detail

DEFAULT

public static final LocalPDBDirectory.ObsoleteBehavior DEFAULT

Method Detail

values

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

Returns:

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

valueOf

public static LocalPDBDirectory.ObsoleteBehavior 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