Package com.thegrizzlylabs.geniusscan.sdk.ui

Enum ScanConfiguration.Filter

java.lang.Object

java.lang.Enum<ScanConfiguration.Filter>

com.thegrizzlylabs.geniusscan.sdk.ui.ScanConfiguration.Filter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScanConfiguration.Filter>

Enclosing class:

ScanConfiguration

public static enum ScanConfiguration.Filter
extends java.lang.Enum<ScanConfiguration.Filter>

The post processing filter to apply to the image.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLACK_AND_WHITE	Filter used to enhance documents with white background and black foreground
COLOR	Filter used to enhance documents with white background and color foreground
NONE	No filter is applied
PHOTO	Filter used to enhance photos, magazine covers...

Method Summary

Modifier and Type	Method	Description
com.thegrizzlylabs.geniusscan.sdk.core.ImageType	toImageType()
static ScanConfiguration.Filter	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ScanConfiguration.Filter[]	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

NONE

public static final ScanConfiguration.Filter NONE

No filter is applied

BLACK_AND_WHITE

public static final ScanConfiguration.Filter BLACK_AND_WHITE

Filter used to enhance documents with white background and black foreground

COLOR

public static final ScanConfiguration.Filter COLOR

Filter used to enhance documents with white background and color foreground

PHOTO

public static final ScanConfiguration.Filter PHOTO

Filter used to enhance photos, magazine covers...

Method Detail

values

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

Returns:

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

valueOf

public static ScanConfiguration.Filter 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

toImageType

public com.thegrizzlylabs.geniusscan.sdk.core.ImageType toImageType()