org.jaitools.tilecache

Enum BasicCacheVisitor.Key

java.lang.Object

java.lang.Enum<BasicCacheVisitor.Key>

org.jaitools.tilecache.BasicCacheVisitor.Key

All Implemented Interfaces:

Serializable, Comparable<BasicCacheVisitor.Key>

Enclosing class:

BasicCacheVisitor

public static enum BasicCacheVisitor.Key
extends Enum<BasicCacheVisitor.Key>

Defines keys to filter the tles visited

Enum Constant Summary

Enum Constants

Enum Constant and Description
OWNER Filter on the image that owns the tile.
RESIDENT Filter on whether the tile is currently resident in memory.

Method Summary

Modifier and Type	Method and Description
Class<?>	getValueClass() Gets the value class.
static BasicCacheVisitor.Key	valueOf(String name) Returns the enum constant of this type with the specified name.
static BasicCacheVisitor.Key[]	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

OWNER

public static final BasicCacheVisitor.Key OWNER

Filter on the image that owns the tile. The value provided for this key must be a RenderedImage.

RESIDENT

public static final BasicCacheVisitor.Key RESIDENT

Filter on whether the tile is currently resident in memory. The value provided for this key must be of type Boolean.

Method Detail

values

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

Returns:

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

valueOf

public static BasicCacheVisitor.Key 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

getValueClass

public Class<?> getValueClass()

Gets the value class.

Returns:

the class