org.geotools.coverage.grid.io

Enum GranuleRemovalPolicy

Object

Enum<GranuleRemovalPolicy>

GranuleRemovalPolicy

All Implemented Interfaces:

Serializable, Comparable<GranuleRemovalPolicy>

public enum GranuleRemovalPolicy
extends Enum<GranuleRemovalPolicy>

Policy to be used while running a removal on GranuleStore.removeGranules(Filter, org.geotools.util.factory.Hints). Needs to be specified as part of the Hints

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Remove both data and metadata
METADATA Remove metadata, but not data
NONE Do not remove granule data nor metadata, simply un-register granules from the GranuleStore

Method Summary

Modifier and Type	Method and Description
static GranuleRemovalPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static GranuleRemovalPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final GranuleRemovalPolicy NONE

Do not remove granule data nor metadata, simply un-register granules from the GranuleStore

METADATA

public static final GranuleRemovalPolicy METADATA

Remove metadata, but not data

ALL

public static final GranuleRemovalPolicy ALL

Remove both data and metadata

Method Detail

values

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

Returns:

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

valueOf

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