Package com.mindee.v2.parsing.inference.field

Class SimpleField

java.lang.Object

com.mindee.v2.parsing.inference.field.BaseField

com.mindee.v2.parsing.inference.field.SimpleField

public final class SimpleField
extends BaseField

Field holding a single scalar value.

Constructor Summary

Constructors

Constructor	Description
SimpleField(Object value, FieldConfidence confidence, List<FieldLocation> locations)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BigDecimal	getBigDecimalValue()	Retrieves the value of the field as a BigDecimal.
Boolean	getBooleanValue()	Retrieves the value of the field as a Boolean.
Double	getDoubleValue()	Retrieves the value of the field as a Double.
String	getStringValue()	Retrieves the value of the field as a String.
Object	getValue()	Value (string, boolean, double, or null).
int	hashCode()
String	toString()

Methods inherited from class com.mindee.v2.parsing.inference.field.BaseField

getConfidence, getLocations, setConfidence, setLocations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleField

public SimpleField(Object value,
                   FieldConfidence confidence,
                   List<FieldLocation> locations)

Method Detail

getStringValue

public String getStringValue()
                      throws ClassCastException

Retrieves the value of the field as a String.

Returns:

the field value as a string

Throws:

ClassCastException - if the value cannot be cast to a string

getDoubleValue

public Double getDoubleValue()
                      throws ClassCastException

Retrieves the value of the field as a Double.

Accepts any Number — the wire deserializer stores numeric values as BigDecimal to preserve precision, but programmatically-constructed fields may hold a Double, Integer, Long, etc. Prefer getBigDecimalValue() when precision matters.

Returns:

the field value as a Double (may lose precision)

Throws:

ClassCastException - if the value is not a Number

getBigDecimalValue

public BigDecimal getBigDecimalValue()
                              throws ClassCastException

Retrieves the value of the field as a BigDecimal.

Accepts any Number. Non-BigDecimal numbers are converted via their string representation to preserve as many digits as possible.

Returns:

the field value as a BigDecimal

Throws:

ClassCastException - if the value is not a Number

getBooleanValue

public Boolean getBooleanValue()
                        throws ClassCastException

Retrieves the value of the field as a Boolean.

Returns:

the field value as a Boolean

Throws:

ClassCastException - if the value cannot be cast to a Boolean

toString

public String toString()

Overrides:

toString in class BaseField

getValue

public Object getValue()

Value (string, boolean, double, or null).

equals

public boolean equals(Object o)

Overrides:

equals in class BaseField

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseField

hashCode

public int hashCode()

Overrides:

hashCode in class BaseField