io.scanbot.sdk.barcode.entity

Class BarcodeScanningResult

java.lang.Object

io.scanbot.sdk.barcode.entity.BarcodeScanningResult

All Implemented Interfaces:

android.os.Parcelable

public class BarcodeScanningResult
extends java.lang.Object
implements android.os.Parcelable

Encapsulates the result of decoding a barcode within an image.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<BarcodeScanningResult>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BarcodeScanningResult(android.os.Parcel in)
	BarcodeScanningResult(java.lang.String text, byte[] rawBytes, int numBits, ResultPoint[] resultPoints, BarcodeFormat format, long timestamp)
	BarcodeScanningResult(java.lang.String text, byte[] rawBytes, ResultPoint[] resultPoints, BarcodeFormat format)
	BarcodeScanningResult(java.lang.String text, byte[] rawBytes, ResultPoint[] resultPoints, BarcodeFormat format, long timestamp)

Method Summary

Modifier and Type	Method and Description
void	addResultPoints(ResultPoint[] newPoints)
int	describeContents()
BarcodeFormat	getBarcodeFormat()
int	getNumBits()
byte[]	getRawBytes()
ResultPoint[]	getResultPoints()
java.lang.String	getText()
long	getTimestamp()
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<BarcodeScanningResult> CREATOR

Constructor Detail

BarcodeScanningResult

public BarcodeScanningResult(java.lang.String text,
                             byte[] rawBytes,
                             ResultPoint[] resultPoints,
                             BarcodeFormat format)

BarcodeScanningResult

public BarcodeScanningResult(java.lang.String text,
                             byte[] rawBytes,
                             ResultPoint[] resultPoints,
                             BarcodeFormat format,
                             long timestamp)

BarcodeScanningResult

public BarcodeScanningResult(java.lang.String text,
                             byte[] rawBytes,
                             int numBits,
                             ResultPoint[] resultPoints,
                             BarcodeFormat format,
                             long timestamp)

BarcodeScanningResult

protected BarcodeScanningResult(android.os.Parcel in)

Method Detail

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

getText

public java.lang.String getText()

Returns:

raw text encoded by the barcode

getRawBytes

public byte[] getRawBytes()

Returns:

raw bytes encoded by the barcode, if applicable, otherwise null

getNumBits

public int getNumBits()

Returns:

how many bits of getRawBytes() are valid; typically 8 times its length

getResultPoints

public ResultPoint[] getResultPoints()

Returns:

points related to the barcode in the image. These are typically points identifying finder patterns or the corners of the barcode. The exact meaning is specific to the type of barcode that was decoded.

getBarcodeFormat

public BarcodeFormat getBarcodeFormat()

Returns:

BarcodeFormat representing the format of the barcode that was decoded

addResultPoints

public void addResultPoints(ResultPoint[] newPoints)

getTimestamp

public long getTimestamp()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object