com.flagstone.transform.filter
Enum FilterMode

java.lang.Object
  java.lang.Enum<FilterMode>
      com.flagstone.transform.filter.FilterMode

All Implemented Interfaces:

Serializable, Comparable<FilterMode>

public enum FilterMode
extends Enum<FilterMode>

FilterMode is used to define how the results from applying a filter to an object are composited with the background.

Enum Constant Summary

INNER
The shadow is applied to the inside of the object.

KNOCKOUT
The original object is removed from the result.

TOP
The result is applied over the existing object.

Method Summary

static FilterMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FilterMode[]	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

INNER

public static final FilterMode INNER

The shadow is applied to the inside of the object.

KNOCKOUT

public static final FilterMode KNOCKOUT

The original object is removed from the result.

TOP

public static final FilterMode TOP

The result is applied over the existing object.

Method Detail

values

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

Returns:

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

valueOf

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