org.geotools.image.io.mosaic
Enum TileWritingPolicy

java.lang.Object
  extended by java.lang.Enum<TileWritingPolicy>
      extended by org.geotools.image.io.mosaic.TileWritingPolicy
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TileWritingPolicy>

public enum TileWritingPolicy
extends java.lang.Enum<TileWritingPolicy>

Controls the way MosaicImageWriter writes the tiles. This include the behavior when a file to be written already exists.

Since:
2.5
Version:
$Id: TileWritingPolicy.java 30729 2008-06-16 09:26:48Z desruisseaux $
Author:
Martin Desruisseaux
See Also:
MosaicImageWriteParam.setTileWritingPolicy(org.geotools.image.io.mosaic.TileWritingPolicy), MosaicBuilder.createTileManager()

Enum Constant Summary
NO_WRITE
          Do not write any tile.
OVERWRITE
          Overwrite existing tiles inconditionnaly.
WRITE_NEWS_NONEMPTY
          Skip existing and empty tiles.
WRITE_NEWS_ONLY
          Skip existing tiles.
 
Method Summary
static TileWritingPolicy valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static TileWritingPolicy[] 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

OVERWRITE

public static final TileWritingPolicy OVERWRITE
Overwrite existing tiles inconditionnaly. This is the default behavior.


WRITE_NEWS_ONLY

public static final TileWritingPolicy WRITE_NEWS_ONLY
Skip existing tiles. This option works only for tile input of type File. Other types like URL are not garanteed to be checked for existence; they may be always overwritten.


WRITE_NEWS_NONEMPTY

public static final TileWritingPolicy WRITE_NEWS_NONEMPTY
Skip existing and empty tiles. This option works like WRITE_NEWS_ONLY, but skips also tiles having all pixels set to 0.


NO_WRITE

public static final TileWritingPolicy NO_WRITE
Do not write any tile. This option can be given to MosaicBuilder.createTileManager(). While it is legal to give this option as a parameter to the writer, this is typically useless except for testing purpose.

Method Detail

values

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

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

valueOf

public static TileWritingPolicy valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null


Copyright © 1996-2010 Geotools. All Rights Reserved.