Back to Zxing

All Classes and Interfaces

docs/apidocs/allclasses-index.html

latest35.3 KB
Original Source

All Classes and Interfaces

All Classes and InterfacesInterfacesClassesEnumsException Classes

Class

Description

AbstractExpandedDecoder

AbstractRSSReader

Superclass of OneDReader implementations that read barcodes in the RSS family of formats.

AddressBookAUResultParser

Implements KDDI AU's address book format.

AddressBookDoCoMoResultParser

Implements the "MECARD" address book entry format.

AddressBookParsedResult

Represents a parsed result that encodes contact information, like that in an address book entry.

AlignmentPattern

Encapsulates an alignment pattern, which are the smaller square patterns found in all but the simplest QR Codes.

AztecCode

Aztec 2D code representation

AztecDetectorResult

Extends DetectorResult with more information specific to the Aztec format, like the number of layers and whether it's compact.

AztecReader

This implementation can detect and decode Aztec codes in an image.

AztecWriter

Renders an Aztec code as a BitMatrix.

BarcodeFormat

Enumerates barcode formats known to this package.

BarcodeMatrix

Holds all of the information for a barcode in a format where it can be easily accessible

Binarizer

This class hierarchy provides a set of methods to convert luminance data to 1 bit data.

BinaryBitmap

This class is the core bitmap class used by ZXing to represent 1 bit data.

BitArray

A simple, fast array of bits, represented compactly by an array of ints internally.

BitMatrix

Represents a 2D matrix of bits.

BitSource

This provides an easy abstraction to read bits at a time from a sequence of bytes, where the number of bits read is not often a multiple of 8.

BizcardResultParser

Implements the "BIZCARD" address book entry format, though this has been largely reverse-engineered from examples observed in the wild -- still looking for a definitive reference.

BookmarkDoCoMoResultParser

BufferedImageLuminanceSource

This LuminanceSource implementation is meant for J2SE clients and our blackbox unit tests.

ByQuadrantReader

This class attempts to decode a barcode from an image, not by scanning the whole image, but by scanning subsets of the image.

ByteMatrix

JAVAPORT: The original code was a 2D array of ints, but since it only ever gets assigned -1, 0, and 1, I'm going to use less memory and go with bytes.

CalendarParsedResult

Represents a parsed result that encodes a calendar event at a certain time, optionally with attendees and a location.

CharacterSetECI

Encapsulates a Character Set ECI, according to "Extended Channel Interpretations" 5.3.1.1 of ISO 18004.

ChartDoSFilter

Protect the /chart endpoint from too many requests.

ChartServlet

A reimplementation of the Google Chart Server's QR code encoder, which is now deprecated.

ChecksumException

Thrown when a barcode was successfully detected and decoded, but was not returned because its checksum feature failed.

CodaBarReader

Decodes Codabar barcodes.

CodaBarWriter

This class renders CodaBar as boolean[].

Code128Reader

Decodes Code 128 barcodes.

Code128Writer

This object renders a CODE128 code as a BitMatrix.

Code39Reader

Decodes Code 39 barcodes.

Code39Writer

This object renders a CODE39 code as a BitMatrix.

Code93Reader

Decodes Code 93 barcodes.

Code93Writer

This object renders a CODE93 code as a BitMatrix

CommandLineEncoder

Command line utility for encoding barcodes.

CommandLineRunner

This simple command line utility decodes files, directories of files, or URIs which are passed as arguments.

Compaction

Represents possible PDF417 barcode compaction types.

DataCharacter

Encapsulates a since character value in an RSS barcode, including its checksum information.

DataMatrixReader

This implementation can detect and decode Data Matrix codes in an image.

DataMatrixWriter

This object renders a Data Matrix code as a BitMatrix 2D array of greyscale values.

DecodeDoSFilter

Protect the /decode endpoint from too many requests.

DecodeHintType

Encapsulates a type of hint that a caller may pass to a barcode reader to help it more quickly or accurately decode it.

Decoder

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

Decoder

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

Decoder

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

Decoder

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

DecoderResult

Encapsulates the result of decoding a matrix of bits.

DecodeServlet

HttpServlet which decodes images containing barcodes.

DefaultGridSampler

DefaultPlacement

Symbol Character Placement Program.

Detector

Encapsulates logic that can detect an Aztec Code in an image, even if the Aztec Code is rotated or skewed, or partially obscured.

Detector

Encapsulates logic that can detect a Data Matrix Code in an image, even if the Data Matrix Code is rotated or skewed, or partially obscured.

Detector

Encapsulates logic that can detect a PDF417 Code in an image, even if the PDF417 Code is rotated or skewed, or partially obscured.

Detector

Encapsulates logic that can detect a QR Code in an image, even if the QR Code is rotated or skewed, or partially obscured.

DetectorResult

Encapsulates the result of detecting a barcode in an image.

Dimension

Simply encapsulates a width and height.

Dimensions

Data object to specify the minimum and maximum number of rows and columns for a PDF417 barcode.

DoSFilter

A simplistic Filter that rejects requests from hosts that are sending too many requests in too short a time.

EAN13Reader

Implements decoding of the EAN-13 format.

EAN13Writer

This object renders an EAN13 code as a BitMatrix.

EAN8Reader

Implements decoding of the EAN-8 format.

EAN8Writer

This object renders an EAN8 code as a BitMatrix.

ECIEncoderSet

Set of CharsetEncoders for a given input string Invariants: - The list contains only encoders from CharacterSetECI (list is shorter then the list of encoders available on the platform for which ECI values are defined)

ECIInput

Interface to navigate a sequence of ECIs and bytes.

ECIStringBuilder

Class that converts a sequence of ECIs and bytes into a string

EmailAddressParsedResult

Represents a parsed result that encodes an email message including recipients, subject and body text.

EmailAddressResultParser

Represents a result that encodes an e-mail address, either as a plain address like "[email protected]" or a mailto: URL like "mailto:[email protected]".

EmailDoCoMoResultParser

Implements the "MATMSG" email message entry format.

EncodeHintType

These are a set of hints that you may pass to Writers to specify their behavior.

Encoder

Generates Aztec 2D barcodes.

Encoder

ErrorCorrection

Error Correction Code for ECC200.

ErrorCorrection

PDF417 error correction implementation.

ErrorCorrectionLevel

See ISO 18004:2006, 6.5.1.

ExpandedProductParsedResult

Represents a parsed result that encodes extended product information as encoded by the RSS format, like weight, price, dates, etc.

ExpandedProductResultParser

Parses strings of digits that represent a RSS Extended code.

FinderPattern

Encapsulates an RSS barcode finder pattern, including its start/end position and row.

FinderPattern

Encapsulates a finder pattern, which are the three square patterns found in the corners of QR Codes.

FinderPatternFinder

This class attempts to find finder patterns in a QR Code.

FinderPatternInfo

Encapsulates information about finder patterns in an image, including the location of the three finder patterns, and their estimated module size.

FormatException

Thrown when a barcode was successfully detected, but some aspect of the content did not conform to the barcode's format rules.

GenericGF

This class contains utility methods for performing mathematical operations over the Galois Fields.

GenericMultipleBarcodeReader

Attempts to locate multiple barcodes in an image by repeatedly decoding portion of the image.

GeoParsedResult

Represents a parsed result that encodes a geographic coordinate, with latitude, longitude and altitude.

GeoResultParser

Parses a "geo:" URI result, which specifies a location on the surface of the Earth as well as an optional altitude above the surface.

GlobalHistogramBinarizer

This Binarizer implementation uses the old ZXing global histogram approach.

GrayscaleLuminanceSource

This class is used to help decode images from files which arrive as a grayscale pixel array.

GridSampler

Implementations of this class can, given locations of finder patterns for a QR code in an image, sample the right points in the image to reconstruct the QR code, accounting for perspective distortion.

GUIRunner

Simple GUI frontend to the library.

HighLevelEncoder

This produces nearly optimal encodings of text into the first-level of encoding used by Aztec code.

HighLevelEncoder

DataMatrix ECC 200 data encoder following the algorithm described in ISO/IEC 16022:200(E) in annex S.

HtmlAssetTranslator

Deprecated. without replacement since 3.4.2

HTTPSFilter

Redirects things to HTTPS, like the main decode page, which should prefer HTTPS.

HybridBinarizer

This class implements a local thresholding algorithm, which while slower than the GlobalHistogramBinarizer, is fairly efficient for what it does.

ImageReader

Encapsulates reading URIs as images.

InvertedLuminanceSource

A wrapper implementation of LuminanceSource which inverts the luminances it returns -- black becomes white and vice versa, and each value becomes (255-value).

ISBNParsedResult

Represents a parsed result that encodes a product ISBN number.

ISBNResultParser

Parses strings of digits that represent a ISBN.

ITFReader

Implements decoding of the ITF format, or Interleaved Two of Five.

ITFWriter

This object renders a ITF code as a BitMatrix.

LuminanceSource

The purpose of this class hierarchy is to abstract different bitmap implementations across platforms into a standard interface for requesting greyscale luminance values.

MathUtils

General math-related and numeric utility functions.

MatrixToImageConfig

Encapsulates custom configuration used in methods of MatrixToImageWriter.

MatrixToImageWriter

Writes a BitMatrix to BufferedImage, file or stream.

MaxiCodeReader

This implementation can detect and decode a MaxiCode in an image.

MinimalECIInput

Class that converts a character string into a sequence of ECIs and bytes The implementation uses the Dijkstra algorithm to produce minimal encodings

MinimalEncoder

Encoder that encodes minimally Algorithm: Uses Dijkstra to produce mathematically minimal encodings that are in some cases smaller than the results produced by the algorithm described in annex S in the specification ISO/IEC 16022:200(E).

Mode

See ISO 18004:2006, 6.4.1, Tables 2 and 3.

ModulusGF

A field based on powers of a generator integer, modulo some modulus.

MonochromeRectangleDetector

Deprecated. without replacement since 3.3.0

MultiDetector

Encapsulates logic that can detect one or more QR Codes in an image, even if the QR Code is rotated or skewed, or partially obscured.

MultiFinderPatternFinder

This class attempts to find finder patterns in a QR Code.

MultiFormatOneDReader

MultiFormatReader

MultiFormatReader is a convenience class and the main entry point into the library for most uses.

MultiFormatUPCEANReader

A reader that can read all available UPC/EAN formats.

MultiFormatWriter

This is a factory class which finds the appropriate Writer subclass for the BarcodeFormat requested and encodes the barcode with the supplied contents.

MultipleBarcodeReader

Implementation of this interface attempt to read several barcodes from one image.

NotFoundException

Thrown when a barcode was not found in the image.

OneDimensionalCodeWriter

Encapsulates functionality and implementation that is common to one-dimensional barcodes.

OneDReader

Encapsulates functionality and implementation that is common to all families of one-dimensional barcodes.

OutputUtils

Utility functions for decoderesult.jspx.

ParsedResult

Abstract class representing the result of decoding a barcode, as more than a String -- as some type of structured data.

ParsedResultType

Represents the type of data encoded by a barcode -- from plain text, to a URI, to an e-mail address, etc.

PDF417

Top-level class for the logic part of the PDF417 implementation.

PDF417Common

PDF417DetectorResult

PDF417HighLevelEncoderTestAdapter

Test adapter for PDF417HighLevelEncoder to be called solely from unit tests.

PDF417Reader

This implementation can detect and decode PDF417 codes in an image.

PDF417ResultMetadata

PDF417ScanningDecoder

PDF417Writer

PerspectiveTransform

This class implements a perspective transform in two dimensions.

PlanarYUVLuminanceSource

This object extends LuminanceSource around an array of YUV data returned from the camera driver, with the option to crop to a rectangle within the full data.

ProductParsedResult

Represents a parsed result that encodes a product by an identifier of some kind.

ProductResultParser

Parses strings of digits that represent a UPC code.

QRCode

QRCodeDecoderMetaData

Meta-data container for QR Code decoding.

QRCodeMultiReader

This implementation can detect and decode multiple QR Codes in an image.

QRCodeReader

This implementation can detect and decode QR Codes in an image.

QRCodeWriter

This object renders a QR Code as a BitMatrix 2D array of greyscale values.

Reader

Implementations of this interface can decode an image of a barcode in some format into the String it encodes.

ReaderException

The general exception class throw when something goes wrong during decoding of a barcode.

ReedSolomonDecoder

Implements Reed-Solomon decoding, as the name implies.

ReedSolomonEncoder

Implements Reed-Solomon encoding, as the name implies.

ReedSolomonException

Thrown when an exception occurs during Reed-Solomon decoding, such as when there are too many errors to correct.

Result

Encapsulates the result of decoding a barcode within an image.

ResultMetadataType

Represents some type of metadata about the result of the decoding that the decoder wishes to communicate back to the caller.

ResultParser

Abstract class representing the result of decoding a barcode, as more than a String -- as some type of structured data.

ResultPoint

Encapsulates a point of interest in an image containing a barcode.

ResultPointCallback

Callback which is invoked when a possible result point (significant point in the barcode image such as a corner) is found.

RGBLuminanceSource

This class is used to help decode images from files which arrive as RGB data from an ARGB pixel array.

RSS14Reader

Decodes RSS-14, including truncated and stacked variants.

RSSExpandedReader

RSSUtils

Adapted from listings in ISO/IEC 24724 Appendix B and Appendix G.

SMSMMSResultParser

Parses an "sms:" URI result, which specifies a number to SMS.

SMSParsedResult

Represents a parsed result that encodes an SMS message, including recipients, subject and body text.

SMSTOMMSTOResultParser

Parses an "smsto:" URI result, whose format is not standardized but appears to be like: smsto:number(:body).

SMTPResultParser

Parses an "smtp:" URI result, whose format is not standardized but appears to be like: smtp[:subject[:body]].

StringsResourceTranslator

Deprecated. without replacement since 3.4.2

StringUtils

Common string-related functions.

SymbolInfo

Symbol info table for DataMatrix.

SymbolShapeHint

Enumeration for DataMatrix symbol shape hint.

TelParsedResult

Represents a parsed result that encodes a telephone number.

TelResultParser

Parses a "tel:" URI result, which specifies a phone number.

TextParsedResult

A simple result type encapsulating a string that has no further interpretation.

TimeoutFilter

Protect the decode endpoint from long-running requests.

UPCAReader

Implements decoding of the UPC-A format.

UPCAWriter

This object renders a UPC-A code as a BitMatrix.

UPCEANReader

Encapsulates functionality and implementation that is common to UPC and EAN families of one-dimensional barcodes.

UPCEANWriter

Encapsulates functionality and implementation that is common to UPC and EAN families of one-dimensional barcodes.

UPCEReader

Implements decoding of the UPC-E format.

UPCEWriter

This object renders an UPC-E code as a BitMatrix.

URIParsedResult

A simple result type encapsulating a URI that has no further interpretation.

URIResultParser

Tries to parse results that are a URI of some kind.

URLTOResultParser

Parses the "URLTO" result format, which is of the form "URLTO:[title]:[url]".

VCardResultParser

Parses contact information formatted according to the VCard (2.1) format.

Version

The Version object encapsulates attributes about a particular size Data Matrix Code.

Version

See ISO 18004:2006 Annex D

Version.ECB

Encapsulates the parameters for one error-correction block in one symbol version.

Version.ECBlocks

Encapsulates a set of error-correction blocks in one symbol version.

VEventResultParser

Partially implements the iCalendar format's "VEVENT" format for specifying a calendar event.

VINParsedResult

Represents a parsed result that encodes a Vehicle Identification Number (VIN).

VINResultParser

Detects a result that is likely a vehicle identification number.

WelcomeFilter

Handles redirects to the app landing page.

WhiteRectangleDetector

Detects a candidate barcode-like rectangular region within an image.

WifiParsedResult

Represents a parsed result that encodes wifi network information, like SSID and password.

WifiResultParser

Writer

The base class for all objects which encode/generate a barcode image.

WriterException

A base class which covers the range of exceptions which may occur when encoding a barcode using the Writer framework.