Package org.moeaframework.util.io

Enum Class Resources.ResourceOption

java.lang.Object

java.lang.Enum<Resources.ResourceOption>

org.moeaframework.util.io.Resources.ResourceOption

All Implemented Interfaces:

Serializable, Comparable<Resources.ResourceOption>, Constable

Enclosing class:

Resources

public static enum Resources.ResourceOption
extends Enum<Resources.ResourceOption>

Options used when locating and extracting resources.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXECUTABLE	Set the executable flag on the file if being extracted.
FILE	First search for a file referenced by the resource path.
REQUIRED	The resource is required and a ResourceNotFoundException is thrown if the resource could not be found.
TEMPORARY	Extracts the resource to a temporary file instead of the path referenced by the resource.

Method Summary

Modifier and Type	Method	Description
static Resources.ResourceOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Resources.ResourceOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FILE

public static final Resources.ResourceOption FILE

First search for a file referenced by the resource path. Any leading "/" in the resource path, which is typically used to indicate the resource path is absolute (starting at the root of the classpath), is ignored when locating the file. The file will be resolved relative to the base directory.

TEMPORARY

public static final Resources.ResourceOption TEMPORARY

Extracts the resource to a temporary file instead of the path referenced by the resource. This option is only used by Resources.asFile(Class, String, ResourceOption...).

EXECUTABLE

public static final Resources.ResourceOption EXECUTABLE

Set the executable flag on the file if being extracted. This option is only used by Resources.asFile(Class, String, ResourceOption...).

REQUIRED

public static final Resources.ResourceOption REQUIRED

The resource is required and a ResourceNotFoundException is thrown if the resource could not be found. There is no need to check for null return values when using this option.

Method Details

values

public static Resources.ResourceOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Resources.ResourceOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null