Package org.biojava.nbio.structure.io

Enum LocalPDBDirectory.FetchBehavior

java.lang.Object

java.lang.Enum<LocalPDBDirectory.FetchBehavior>

org.biojava.nbio.structure.io.LocalPDBDirectory.FetchBehavior

All Implemented Interfaces:

Serializable, Comparable<LocalPDBDirectory.FetchBehavior>

Enclosing class:

LocalPDBDirectory

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

Controls when the class should fetch files from the ftp server

Author:

Spencer Bliven

Enum Constant Summary

Enum Constants

Enum Constant	Description
FETCH_FILES	Fetch missing files from the server.
FETCH_IF_OUTDATED	Fetch missing files from the server, also fetch if file present but older than the server file.
FETCH_REMEDIATED	Fetch missing files from the server.
FORCE_DOWNLOAD	For every file, force downloading from the server
LOCAL_ONLY	Never fetch from the server; Throw errors for missing files

Field Summary

Fields

Modifier and Type	Field	Description
static LocalPDBDirectory.FetchBehavior	DEFAULT

Method Summary

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

LOCAL_ONLY

public static final LocalPDBDirectory.FetchBehavior LOCAL_ONLY

Never fetch from the server; Throw errors for missing files

FETCH_FILES

public static final LocalPDBDirectory.FetchBehavior FETCH_FILES

Fetch missing files from the server. Don't check for outdated files

FETCH_IF_OUTDATED

public static final LocalPDBDirectory.FetchBehavior FETCH_IF_OUTDATED

Fetch missing files from the server, also fetch if file present but older than the server file. This requires always querying the server for the last modified time of the file, thus it adds an overhead to getting files from cache.

FETCH_REMEDIATED

public static final LocalPDBDirectory.FetchBehavior FETCH_REMEDIATED

Fetch missing files from the server. Also force the download of files older than "2011/07/12".

FORCE_DOWNLOAD

public static final LocalPDBDirectory.FetchBehavior FORCE_DOWNLOAD

For every file, force downloading from the server

Field Detail

DEFAULT

public static final LocalPDBDirectory.FetchBehavior DEFAULT

Method Detail

values

public static LocalPDBDirectory.FetchBehavior[] 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.FetchBehavior c : LocalPDBDirectory.FetchBehavior.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.FetchBehavior 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