Package org.apache.accumulo.core.spi.scan

Enum ScanDirectives.CacheUsage

java.lang.Object

java.lang.Enum<ScanDirectives.CacheUsage>

org.apache.accumulo.core.spi.scan.ScanDirectives.CacheUsage

All Implemented Interfaces:

Serializable, Comparable<ScanDirectives.CacheUsage>

Enclosing interface:

ScanDirectives

public static enum ScanDirectives.CacheUsage
extends Enum<ScanDirectives.CacheUsage>

Communicates how a scan should use cache.

Since:

2.1.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Do not use cache for this scan, possibly overriding table settings.
ENABLED	Use cache for this can, possibly overriding table settings.
OPPORTUNISTIC	Use data if it exists in cache, but never load data into cache.
TABLE	Use the tables cache settings for this scan.

Method Summary

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

ENABLED

public static final ScanDirectives.CacheUsage ENABLED

Use cache for this can, possibly overriding table settings.

DISABLED

public static final ScanDirectives.CacheUsage DISABLED

Do not use cache for this scan, possibly overriding table settings.

OPPORTUNISTIC

public static final ScanDirectives.CacheUsage OPPORTUNISTIC

Use data if it exists in cache, but never load data into cache.

TABLE

public static final ScanDirectives.CacheUsage TABLE

Use the tables cache settings for this scan.

Method Detail

values

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

Returns:

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

valueOf

public static ScanDirectives.CacheUsage 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