com.badlogic.gdx

Enum Files.FileType

java.lang.Object

java.lang.Enum<Files.FileType>

com.badlogic.gdx.Files.FileType

All Implemented Interfaces:

Serializable, Comparable<Files.FileType>

Enclosing interface:

Files

public static enum Files.FileType
extends Enum<Files.FileType>

Indicates how to resolve a path to a file.

Author:

mzechner, Nathan Sweet

Enum Constant Summary

Enum Constants

Enum Constant and Description
Absolute Path that is a fully qualified, absolute filesystem path.
Classpath Path relative to the root of the classpath.
External Path relative to the root of the SD card on Android and to the home directory of the current user on the desktop.
Internal Path relative to the asset directory on Android and to the application's root directory on the desktop.
Local Path relative to the private files directory on Android and to the application's root directory on the desktop.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Classpath

public static final Files.FileType Classpath

Path relative to the root of the classpath. Classpath files are always readonly. Note that classpath files are not compatible with some functionality on Android, such as Audio.newSound(FileHandle) and Audio.newMusic(FileHandle).

Internal

public static final Files.FileType Internal

Path relative to the asset directory on Android and to the application's root directory on the desktop. On the desktop, if the file is not found, then the classpath is checked. This enables files to be found when using JWS or applets. Internal files are always readonly.

External

public static final Files.FileType External

Path relative to the root of the SD card on Android and to the home directory of the current user on the desktop.

Absolute

public static final Files.FileType Absolute

Path that is a fully qualified, absolute filesystem path. To ensure portability across platforms use absolute files only when absolutely (heh) necessary.

Local

public static final Files.FileType Local

Path relative to the private files directory on Android and to the application's root directory on the desktop.

Method Detail

values

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

Returns:

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

valueOf

public static Files.FileType 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