org.gridfour.gvrs

Enum GvrsCacheSize

java.lang.Object

java.lang.Enum<GvrsCacheSize>

org.gridfour.gvrs.GvrsCacheSize

All Implemented Interfaces:

Serializable, Comparable<GvrsCacheSize>

public enum GvrsCacheSize
extends Enum<GvrsCacheSize>

Specifies the size of a tile cache for the GvrsFile class. In general, large caches support faster data access but require more memory. Smaller caches conserve memory, but may result in reduced performance for data queries and storage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Large A larger cache size intended to support higher performance applications and creating new raster files.
Medium A moderate cache size providing better performance than the smaller size, though consuming additional memory, this setting is the default value.
Small The smallest cache size, makes conservative use of memory.

Method Summary

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

Small

public static final GvrsCacheSize Small

The smallest cache size, makes conservative use of memory. May result in reduced performance compared to the larger cache sizes.

The maximum memory size for this specification is currently 2 megabytes, but that value is subject to change in future versions of this code.

Medium

public static final GvrsCacheSize Medium

A moderate cache size providing better performance than the smaller size, though consuming additional memory, this setting is the default value.

The maximum memory size for this specification is currently 12 megabytes, but that value is subject to change in future versions of this code.

Large

public static final GvrsCacheSize Large

A larger cache size intended to support higher performance applications and creating new raster files. This cache size is recommended for high-performance applications that are willing to dedicate a substantial block of memory to a single GvrsFile instance.

The maximum memory size for this specification is currently 256 megabytes, but that value is subject to change in future versions of this code.

Method Detail

values

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

Returns:

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

valueOf

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