io.scanbot.genericdocument.entity

Class Field

io.scanbot.genericdocument.entity.Field

public class Field

Document field.

Constructor Detail

Field

public Field(@NotNull
             io.scanbot.genericdocument.entity.Field.Type type,
             @Nullable
             OcrResult value,
             @Nullable
             android.graphics.Bitmap image,
             @Nullable
             ValidationStatus validationStatus)

Document field.

Parameters:

type - the type of the field.

value - optional value of the field. Applicable only to text fields.

image - image crop of the field.

validationStatus - field validation status. Applicable only to fields that support some kind of validation.

Method Detail

getType

@NotNull
public io.scanbot.genericdocument.entity.Field.Type getType()

the type of the field.

getValue

@Nullable
public OcrResult getValue()

optional value of the field.

Applicable only to text fields.

getImage

@Nullable
public android.graphics.Bitmap getImage()

image crop of the field.

getValidationStatus

@Nullable
public ValidationStatus getValidationStatus()

field validation status.

Applicable only to fields that support some kind of validation.

component1

@NotNull
public io.scanbot.genericdocument.entity.Field.Type component1()

the type of the field.

component2

@Nullable
public OcrResult component2()

optional value of the field.

Applicable only to text fields.

component3

@Nullable
public android.graphics.Bitmap component3()

image crop of the field.

component4

@Nullable
public ValidationStatus component4()

field validation status.

Applicable only to fields that support some kind of validation.

copy

@NotNull
public Field copy(@NotNull
                           io.scanbot.genericdocument.entity.Field.Type type,
                           @Nullable
                           OcrResult value,
                           @Nullable
                           android.graphics.Bitmap image,
                           @Nullable
                           ValidationStatus validationStatus)

Document field.

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)