org.jaitools.jiffle
Enum Jiffle.ImageRole

java.lang.Object
  extended by java.lang.Enum<Jiffle.ImageRole>
      extended by org.jaitools.jiffle.Jiffle.ImageRole
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Jiffle.ImageRole>
Enclosing class:
Jiffle

public static enum Jiffle.ImageRole
extends java.lang.Enum<Jiffle.ImageRole>

Used to specify the roles of images referenced in a Jiffle script. An image may be either read-only (SOURCE) or write-only (DEST) but not both.


Enum Constant Summary
DEST
          Indicates an image is used for output (write-only)
SOURCE
          Indicates an image is used for input (read-only)
 
Method Summary
static Jiffle.ImageRole valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Jiffle.ImageRole[] 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

SOURCE

public static final Jiffle.ImageRole SOURCE
Indicates an image is used for input (read-only)


DEST

public static final Jiffle.ImageRole DEST
Indicates an image is used for output (write-only)

Method Detail

values

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

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

valueOf

public static Jiffle.ImageRole 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 © 2011. All Rights Reserved.