Package com.mindee.parsing.v2.field

Enum FieldConfidence

java.lang.Object

java.lang.Enum<FieldConfidence>

com.mindee.parsing.v2.field.FieldConfidence

All Implemented Interfaces:

Serializable, Comparable<FieldConfidence>

public enum FieldConfidence
extends Enum<FieldConfidence>

Confidence level of a field as returned by the V2 API.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Certain
High
Low
Medium

Method Summary

Modifier and Type	Method	Description
static FieldConfidence	fromJson(String value)
boolean	greaterThan(FieldConfidence other)	Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is greater.
boolean	greaterThanOrEqual(FieldConfidence other)	Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is greater than or equal to the specified level.
boolean	lessThan(FieldConfidence other)	Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is less than the specified level.
boolean	lessThanOrEqual(FieldConfidence other)	Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is less than or equal to the specified level.
String	toJson()
static FieldConfidence	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FieldConfidence[]	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

Low

public static final FieldConfidence Low

Medium

public static final FieldConfidence Medium

High

public static final FieldConfidence High

Certain

public static final FieldConfidence Certain

Method Detail

values

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

Returns:

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

valueOf

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

toJson

public String toJson()

fromJson

public static FieldConfidence fromJson(String value)

greaterThan

public boolean greaterThan(FieldConfidence other)

Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is greater.

Parameters:

other - the other FieldConfidence level to compare against

Returns:

true if the current FieldConfidence level is greater than the specified level, false otherwise

greaterThanOrEqual

public boolean greaterThanOrEqual(FieldConfidence other)

Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is greater than or equal to the specified level.

Parameters:

other - the other FieldConfidence level to compare against

Returns:

true if the current FieldConfidence level is greater than or equal to the specified level, false otherwise

lessThan

public boolean lessThan(FieldConfidence other)

Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is less than the specified level.

Parameters:

other - the other FieldConfidence level to compare against

Returns:

true if the current FieldConfidence level is less than the specified level, false otherwise

lessThanOrEqual

public boolean lessThanOrEqual(FieldConfidence other)

Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is less than or equal to the specified level.

Parameters:

other - the other FieldConfidence level to compare against

Returns:

true if the current FieldConfidence level is less than or equal to the specified level, false otherwise