Package org.geotools.coverage.grid.io

Enum Class GranuleRemovalPolicy

Object

Enum<GranuleRemovalPolicy>

GranuleRemovalPolicy

All Implemented Interfaces:

Serializable, Comparable<GranuleRemovalPolicy>, Constable

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

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
static GranuleRemovalPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GranuleRemovalPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static GranuleRemovalPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static GranuleRemovalPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null