org.acra.file

Enum Directory

java.lang.Object

java.lang.Enum<Directory>

org.acra.file.Directory

All Implemented Interfaces:

Serializable, Comparable<Directory>

public enum Directory
extends Enum<Directory>

Since:

4.9.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
CACHE Directory returned by Context.getCacheDir()
EXTERNAL_CACHE Directory returned by Context.getExternalCacheDir()
EXTERNAL_FILES Directory returned by Context.getExternalFilesDir(String)
EXTERNAL_STORAGE Directory returned by Environment.getExternalStorageDirectory()
FILES Directory returned by Context.getFilesDir()
FILES_LEGACY Legacy behaviour: If the string starts with a path separator, this behaves like ROOT.
NO_BACKUP_FILES Directory returned by Context.getNoBackupFilesDir().
ROOT Root Directory, paths in this directory are absolute paths

Method Summary

Modifier and Type	Method and Description
abstract File	getFile(Context context, String fileName)
static Directory	valueOf(String name) Returns the enum constant of this type with the specified name.
static Directory[]	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

FILES_LEGACY

public static final Directory FILES_LEGACY

Legacy behaviour: If the string starts with a path separator, this behaves like ROOT. Otherwise it behaves like FILES.

FILES

public static final Directory FILES

Directory returned by Context.getFilesDir()

EXTERNAL_FILES

public static final Directory EXTERNAL_FILES

Directory returned by Context.getExternalFilesDir(String)

CACHE

public static final Directory CACHE

Directory returned by Context.getCacheDir()

EXTERNAL_CACHE

public static final Directory EXTERNAL_CACHE

Directory returned by Context.getExternalCacheDir()

NO_BACKUP_FILES

public static final Directory NO_BACKUP_FILES

Directory returned by Context.getNoBackupFilesDir(). Will fall back to Context.getFilesDir() on API < 21

EXTERNAL_STORAGE

public static final Directory EXTERNAL_STORAGE

Directory returned by Environment.getExternalStorageDirectory()

ROOT

public static final Directory ROOT

Root Directory, paths in this directory are absolute paths

Method Detail

values

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

Returns:

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

valueOf

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

getFile

@NonNull
public abstract File getFile(@NonNull
                                      Context context,
                                      @NonNull
                                      String fileName)