ar.com.hjg.pngj.chunks
Enum PngChunk.ChunkOrderingConstraint

java.lang.Object
  extended by java.lang.Enum<PngChunk.ChunkOrderingConstraint>
      extended by ar.com.hjg.pngj.chunks.PngChunk.ChunkOrderingConstraint
All Implemented Interfaces:
Serializable, Comparable<PngChunk.ChunkOrderingConstraint>
Enclosing class:
PngChunk

public static enum PngChunk.ChunkOrderingConstraint
extends Enum<PngChunk.ChunkOrderingConstraint>

Possible ordering constraint for a PngChunk type -only relevant for ancillary chunks. Theoretically, there could be more general constraints, but these cover the constraints for standard chunks.


Enum Constant Summary
AFTER_PLTE_BEFORE_IDAT
          Must go after PLTE but before IDAT
BEFORE_IDAT
          Must before IDAT (before or after PLTE)
BEFORE_PLTE_AND_IDAT
          Must go before PLTE (and hence, also before IDAT)
NA
          Does not apply
NONE
          no ordering constraint
 
Method Summary
 boolean mustGoAfterPLTE()
           
 boolean mustGoBeforeIDAT()
           
 boolean mustGoBeforePLTE()
           
static PngChunk.ChunkOrderingConstraint valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PngChunk.ChunkOrderingConstraint[] 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

AFTER_PLTE_BEFORE_IDAT

public static final PngChunk.ChunkOrderingConstraint AFTER_PLTE_BEFORE_IDAT
Must go after PLTE but before IDAT


BEFORE_IDAT

public static final PngChunk.ChunkOrderingConstraint BEFORE_IDAT
Must before IDAT (before or after PLTE)


BEFORE_PLTE_AND_IDAT

public static final PngChunk.ChunkOrderingConstraint BEFORE_PLTE_AND_IDAT
Must go before PLTE (and hence, also before IDAT)


NA

public static final PngChunk.ChunkOrderingConstraint NA
Does not apply


NONE

public static final PngChunk.ChunkOrderingConstraint NONE
no ordering constraint

Method Detail

mustGoAfterPLTE

public boolean mustGoAfterPLTE()

mustGoBeforeIDAT

public boolean mustGoBeforeIDAT()

mustGoBeforePLTE

public boolean mustGoBeforePLTE()

valueOf

public static PngChunk.ChunkOrderingConstraint 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

values

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

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