org.pdfclown.tools
Enum TextExtractor.AreaModeEnum

java.lang.Object
  java.lang.Enum<TextExtractor.AreaModeEnum>
      org.pdfclown.tools.TextExtractor.AreaModeEnum

All Implemented Interfaces:

Serializable, Comparable<TextExtractor.AreaModeEnum>

Enclosing class:

TextExtractor

public static enum TextExtractor.AreaModeEnum
extends Enum<TextExtractor.AreaModeEnum>

Text-to-area matching mode.

Enum Constant Summary

Containment
Text string must be contained by the area.

Intersection
Text string must intersect the area.

Method Summary

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

Containment

public static final TextExtractor.AreaModeEnum Containment

Text string must be contained by the area.

Intersection

public static final TextExtractor.AreaModeEnum Intersection

Text string must intersect the area.

Method Detail

values

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

Returns:

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

valueOf

public static TextExtractor.AreaModeEnum 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