ar.com.hjg.pngj.chunks
Enum ChunkLoadBehaviour

java.lang.Object
  extended by java.lang.Enum<ChunkLoadBehaviour>
      extended by ar.com.hjg.pngj.chunks.ChunkLoadBehaviour
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ChunkLoadBehaviour>

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

Defines gral strategy about what to do with ancillary (non-critical) chunks when reading


Enum Constant Summary
LOAD_CHUNK_ALWAYS
          Load all chunks.
LOAD_CHUNK_IF_SAFE
          Load chunk if "known" or "safe to copy".
LOAD_CHUNK_KNOWN
          Ancillary chunks are loaded only if 'known' (registered with the factory).
LOAD_CHUNK_NEVER
          All non-critical chunks are skipped
 
Method Summary
static ChunkLoadBehaviour valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ChunkLoadBehaviour[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

LOAD_CHUNK_ALWAYS

public static final ChunkLoadBehaviour LOAD_CHUNK_ALWAYS
Load all chunks.
Notice that other restrictions might apply, see PngReader.skipChunkMaxSize PngReader.skipChunkIds


LOAD_CHUNK_IF_SAFE

public static final ChunkLoadBehaviour LOAD_CHUNK_IF_SAFE
Load chunk if "known" or "safe to copy".


LOAD_CHUNK_KNOWN

public static final ChunkLoadBehaviour LOAD_CHUNK_KNOWN
Ancillary chunks are loaded only if 'known' (registered with the factory).


LOAD_CHUNK_NEVER

public static final ChunkLoadBehaviour LOAD_CHUNK_NEVER
All non-critical chunks are skipped

Method Detail

valueOf

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

values

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

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