com.jtm.qrcode.qrcode.decoder

Class Decoder

java.lang.Object

com.jtm.qrcode.qrcode.decoder.Decoder

public final class Decoder
extends java.lang.Object

The main class which implements QR Code decoding -- as opposed to locating and extracting the QR Code from an image.

Constructor Summary

Constructors

Constructor and Description
Decoder()

Method Summary

Modifier and Type	Method and Description
DecoderResult	decode(BitMatrix bits)
DecoderResult	decode(BitMatrix bits, java.util.Map<DecodeHintType,?> hints) Decodes a QR Code represented as a BitMatrix.
DecoderResult	decode(boolean[][] image)
DecoderResult	decode(boolean[][] image, java.util.Map<DecodeHintType,?> hints) Convenience method that can decode a QR Code represented as a 2D array of booleans.

Methods inherited from class java.lang.Object

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

Constructor Detail

Decoder

public Decoder()

Method Detail

decode

public DecoderResult decode(boolean[][] image)
                     throws ChecksumException,
                            FormatException

Throws:

ChecksumException

FormatException

decode

public DecoderResult decode(boolean[][] image,
                            java.util.Map<DecodeHintType,?> hints)
                     throws ChecksumException,
                            FormatException

Convenience method that can decode a QR Code represented as a 2D array of booleans. "true" is taken to mean a black module.

Parameters:

image - booleans representing white/black QR Code modules

Returns:

text and bytes encoded within the QR Code

Throws:

ChecksumException

FormatException

decode

public DecoderResult decode(BitMatrix bits)
                     throws ChecksumException,
                            FormatException

Throws:

ChecksumException

FormatException

decode

public DecoderResult decode(BitMatrix bits,
                            java.util.Map<DecodeHintType,?> hints)
                     throws FormatException,
                            ChecksumException

Decodes a QR Code represented as a BitMatrix. A 1 or "true" is taken to mean a black module.

Parameters:

bits - booleans representing white/black QR Code modules

Returns:

text and bytes encoded within the QR Code

Throws:

FormatException

ChecksumException