org.broadinstitute.hellbender.utils.R

Enum RScriptLibrary

java.lang.Object

java.lang.Enum<RScriptLibrary>

org.broadinstitute.hellbender.utils.R.RScriptLibrary

All Implemented Interfaces:

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

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

Libraries embedded in the StingUtils package.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GSALIB

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	R_LIBRARY_SUFFIX

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLibraryName()
java.lang.String	getResourcePath()
static RScriptLibrary	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RScriptLibrary[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
java.io.File	writeLibraryToTempFile(java.io.File targetDir) Retrieve the resource for this library and write it to a temp File in targetDir.
java.io.File	writeTemp() Writes the library source code to a temporary tar.gz file and returns the path.

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

GSALIB

public static final RScriptLibrary GSALIB

Field Detail

R_LIBRARY_SUFFIX

public static final java.lang.String R_LIBRARY_SUFFIX

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getLibraryName

public java.lang.String getLibraryName()

getResourcePath

public java.lang.String getResourcePath()

writeTemp

public java.io.File writeTemp()

Writes the library source code to a temporary tar.gz file and returns the path.

Returns:

The path to the library source code.

writeLibraryToTempFile

public java.io.File writeLibraryToTempFile(java.io.File targetDir)

Retrieve the resource for this library and write it to a temp File in targetDir. The File is automatically scheduled for deletion on exit.

Parameters:

targetDir - target directory where the File should be written

Returns:

the newly created temporary File containing the library