org.jaitools.tilecache
Enum DiskCachedTile.TileAction

java.lang.Object
  extended by java.lang.Enum<DiskCachedTile.TileAction>
      extended by org.jaitools.tilecache.DiskCachedTile.TileAction
All Implemented Interfaces:
Serializable, Comparable<DiskCachedTile.TileAction>
Enclosing class:
DiskCachedTile

public static enum DiskCachedTile.TileAction
extends Enum<DiskCachedTile.TileAction>

Constants identifying tile actions.


Enum Constant Summary
ACTION_ACCESSED
          Value that will be returned by getAction() when the tile is accessed via the cache
ACTION_ADDED
          Value that will be returned by getAction() when the tile has been added to the cache
ACTION_ADDED_RESIDENT
          Value that will be returned by getAction() when the tile has been added to the cache and immediately loaded into memory
ACTION_GARBAGE_COLLECTED
          Value that will be returned by getAction() when the tile's raster has been garbage collected
ACTION_NON_RESIDENT
          Value that will be returned by getAction() when the tile is removed from memory
ACTION_REMOVED
          Value that will be returned by getAction() when the tile is removed from the cache entirely
ACTION_RESIDENT
          Value that will be returned by getAction() when the tile becomes resident in memory
 
Method Summary
static DiskCachedTile.TileAction get(int actionValue)
          Reverse lookup.
 int getAction()
          Retrieves an int associated to this action for interoperability with CachedTile interface.
static DiskCachedTile.TileAction getDefault()
          The default action.
 String getDescription()
          Retrieves a description of this action
static DiskCachedTile.TileAction valueOf(String name)
          Returns the enum constant of this type with the specified name.
static DiskCachedTile.TileAction[] 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

ACTION_ADDED

public static final DiskCachedTile.TileAction ACTION_ADDED
Value that will be returned by getAction() when the tile has been added to the cache


ACTION_ADDED_RESIDENT

public static final DiskCachedTile.TileAction ACTION_ADDED_RESIDENT
Value that will be returned by getAction() when the tile has been added to the cache and immediately loaded into memory


ACTION_RESIDENT

public static final DiskCachedTile.TileAction ACTION_RESIDENT
Value that will be returned by getAction() when the tile becomes resident in memory


ACTION_NON_RESIDENT

public static final DiskCachedTile.TileAction ACTION_NON_RESIDENT
Value that will be returned by getAction() when the tile is removed from memory


ACTION_REMOVED

public static final DiskCachedTile.TileAction ACTION_REMOVED
Value that will be returned by getAction() when the tile is removed from the cache entirely


ACTION_ACCESSED

public static final DiskCachedTile.TileAction ACTION_ACCESSED
Value that will be returned by getAction() when the tile is accessed via the cache


ACTION_GARBAGE_COLLECTED

public static final DiskCachedTile.TileAction ACTION_GARBAGE_COLLECTED
Value that will be returned by getAction() when the tile's raster has been garbage collected

Method Detail

values

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

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

valueOf

public static DiskCachedTile.TileAction 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

getAction

public int getAction()
Retrieves an int associated to this action for interoperability with CachedTile interface.

Returns:
an int associated to this action for interoperability with CachedTile interface.

getDescription

public String getDescription()
Retrieves a description of this action

Returns:
a description of this action

get

public static DiskCachedTile.TileAction get(int actionValue)
Reverse lookup.

Parameters:
actionValue - integer value of the action
Returns:
the corresponding TileAction

getDefault

public static DiskCachedTile.TileAction getDefault()
The default action.

Returns:
the default action.


Copyright © 2009-2013. All Rights Reserved.