Package com.google.zxing

Class Result

java.lang.Object

com.google.zxing.Result

public final class Result
extends java.lang.Object

Encapsulates the result of decoding a barcode within an image.

Field Summary

Fields

Modifier and Type	Field	Description
private BarcodeFormat	format
private int	numBits
private byte[]	rawBytes
private java.util.Map<ResultMetadataType,java.lang.Object>	resultMetadata
private ResultPoint[]	resultPoints
private java.lang.String	text
private long	timestamp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addResultPoints(ResultPoint[] newPoints)
BarcodeFormat	getBarcodeFormat()
int	getNumBits()
byte[]	getRawBytes()
java.util.Map<ResultMetadataType,java.lang.Object>	getResultMetadata()
ResultPoint[]	getResultPoints()
java.lang.String	getText()
long	getTimestamp()
void	putAllMetadata(java.util.Map<ResultMetadataType,java.lang.Object> metadata)
void	putMetadata(ResultMetadataType type, java.lang.Object value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

text

private final java.lang.String text

rawBytes

private final byte[] rawBytes

numBits

private final int numBits

resultPoints

private ResultPoint[] resultPoints

format

private final BarcodeFormat format

resultMetadata

private java.util.Map<ResultMetadataType,java.lang.Object> resultMetadata

timestamp

private final long timestamp

Constructor Detail

Result

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

Result

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

Result

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

Method Detail

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

Since:

3.3.0

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

getResultMetadata

public java.util.Map<ResultMetadataType,java.lang.Object> getResultMetadata()

Returns:

Map mapping ResultMetadataType keys to values. May be null. This contains optional metadata about what was detected about the barcode, like orientation.

putMetadata

public void putMetadata(ResultMetadataType type,
                        java.lang.Object value)

putAllMetadata

public void putAllMetadata(java.util.Map<ResultMetadataType,java.lang.Object> metadata)

addResultPoints

public void addResultPoints(ResultPoint[] newPoints)

getTimestamp

public long getTimestamp()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object