com.android.builder.utils

Enum FileCache.FileProperties

java.lang.Object

java.lang.Enum<FileCache.FileProperties>

com.android.builder.utils.FileCache.FileProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileCache.FileProperties>

Enclosing class:

FileCache

public static enum FileCache.FileProperties
extends java.lang.Enum<FileCache.FileProperties>

Properties of a regular file (not a directory) to be used when constructing the cache inputs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HASH The properties include the hash of the given regular file (not a directory).
PATH_HASH The properties include the (not-yet-normalized) path and hash of the given regular file (not a directory).
PATH_SIZE_TIMESTAMP The properties include the (not-yet-normalized) path, size, and timestamp of a regular file (not a directory).

Method Summary

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

HASH

public static final FileCache.FileProperties HASH

The properties include the hash of the given regular file (not a directory).

This is the recommended way of constructing the cache inputs for a regular file. Note that the properties do not include the path or name of the given file. Clients can consider using PATH_HASH to also include the file's path in the cache inputs (typically for debugging purposes).

PATH_HASH

public static final FileCache.FileProperties PATH_HASH

The properties include the (not-yet-normalized) path and hash of the given regular file (not a directory).

This option is similar to HASH except that the file's path is also included in the cache inputs, typically for debugging purposes (e.g., to find out what file a cache entry is created from).

PATH_SIZE_TIMESTAMP

public static final FileCache.FileProperties PATH_SIZE_TIMESTAMP

The properties include the (not-yet-normalized) path, size, and timestamp of a regular file (not a directory).

WARNING: Although this option is faster than using HASH, it is not as safe. The main reason is that, due to the granularity of filesystem timestamps, timestamps may actually not change between two consecutive writes. This will lead to incorrect cache entries. This option should only be used after careful consideration and with knowledge of its limitations. Otherwise, HASH should be used instead.

Method Detail

values

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

Returns:

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

valueOf

public static FileCache.FileProperties 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