Package com.geniusscansdk.scanflow

Enum ScanConfiguration.OcrOutputFormat

java.lang.Object

java.lang.Enum<ScanConfiguration.OcrOutputFormat>

com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat

All Implemented Interfaces:

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

Enclosing class:

ScanConfiguration

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

The various formats into which the OCR result can be made available.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HOCR	Output OCR result in HOCR format
RAW_TEXT	Output OCR result as raw text
TEXT_LAYER_IN_PDF	Add OCR result as a text layer in the generated PDF file (if any)

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.EnumSet<ScanConfiguration.OcrOutputFormat>	ALL

Method Summary

Modifier and Type	Method	Description
static java.util.EnumSet<ScanConfiguration.OcrOutputFormat>	fromCodes(java.util.List<java.lang.String> codes)
static ScanConfiguration.OcrOutputFormat	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ScanConfiguration.OcrOutputFormat[]	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

RAW_TEXT

public static final ScanConfiguration.OcrOutputFormat RAW_TEXT

Output OCR result as raw text

HOCR

public static final ScanConfiguration.OcrOutputFormat HOCR

Output OCR result in HOCR format

TEXT_LAYER_IN_PDF

public static final ScanConfiguration.OcrOutputFormat TEXT_LAYER_IN_PDF

Add OCR result as a text layer in the generated PDF file (if any)

Field Detail

ALL

public static final java.util.EnumSet<ScanConfiguration.OcrOutputFormat> ALL

Method Detail

values

public static ScanConfiguration.OcrOutputFormat[] 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.OcrOutputFormat c : ScanConfiguration.OcrOutputFormat.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.OcrOutputFormat 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

fromCodes

public static java.util.EnumSet<ScanConfiguration.OcrOutputFormat> fromCodes(java.util.List<java.lang.String> codes)