ZXing

https://zxing.github.io/zxing/
Admin
ZXing is an open-source, multi-format 1D and 2D barcode image processing library implemented in Java...
Tokens:171,029
Snippets:1,636
Trust Score:9.7
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### getStart()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/result/CalendarParsedResult.html

Deprecated getter for the start time as a Date.

```APIDOC
## getStart()

### Description
Returns the start time as a Date. Deprecated; use getStartTimestamp() instead.

### Method Signature
`@Deprecated public Date getStart()`

### Returns
- **Date** - The start time.
```

--------------------------------

### getStartTimestamp()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/result/CalendarParsedResult.html

Getter for the start time as a long timestamp.

```APIDOC
## getStartTimestamp()

### Description
Returns the start time as a long timestamp.

### Method Signature
`public long getStartTimestamp()`

### Returns
- **long** - The start time as a timestamp.
```

--------------------------------

### isStartAllDay()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/result/CalendarParsedResult.html

Indicates if the start time is all-day.

```APIDOC
## isStartAllDay()

### Description
Returns whether the start time was specified as a whole day.

### Method Signature
`public boolean isStartAllDay()`

### Returns
- **boolean** - true if start time is all-day.
```

--------------------------------

### sampleGrid(BitMatrix image, int dimensionX, int dimensionY, float p1ToX, float p1ToY, float p2ToX, float p2ToY, float p3ToX, float p3ToY, float p4ToX, float p4ToY, float p1FromX, float p1FromY, float p2FromX, float p2FromY, float p3FromX, float p3FromY, float p4FromX, float p4FromY)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/DefaultGridSampler.html

Samples an image for a rectangular matrix of bits of the given dimension. The sampling transformation is determined by the coordinates of 4 points, in the original and transformed image space.

```APIDOC
## sampleGrid(BitMatrix image, int dimensionX, int dimensionY, float p1ToX, float p1ToY, float p2ToX, float p2ToY, float p3ToX, float p3ToY, float p4ToX, float p4ToY, float p1FromX, float p1FromY, float p2FromX, float p2FromY, float p3FromX, float p3FromY, float p4FromX, float p4FromY)

### Description
Samples an image for a rectangular matrix of bits of the given dimension. The sampling transformation is determined by the coordinates of 4 points, in the original and transformed image space.

### Method
sampleGrid

### Signature
`public BitMatrix sampleGrid(BitMatrix image, int dimensionX, int dimensionY, float p1ToX, float p1ToY, float p2ToX, float p2ToY, float p3ToX, float p3ToY, float p4ToX, float p4ToY, float p1FromX, float p1FromY, float p2FromX, float p2FromY, float p3FromX, float p3FromY, float p4FromX, float p4FromY) throws NotFoundException`

### Parameters
- **image** (BitMatrix) - Required - image to sample
- **dimensionX** (int) - Required - width of BitMatrix to sample from image
- **dimensionY** (int) - Required - height of BitMatrix to sample from image
- **p1ToX** (float) - Required - point 1 preimage X
- **p1ToY** (float) - Required - point 1 preimage Y
- **p2ToX** (float) - Required - point 2 preimage X
- **p2ToY** (float) - Required - point 2 preimage Y
- **p3ToX** (float) - Required - point 3 preimage X
- **p3ToY** (float) - Required - point 3 preimage Y
- **p4ToX** (float) - Required - point 4 preimage X
- **p4ToY** (float) - Required - point 4 preimage Y
- **p1FromX** (float) - Required - point 1 image X
- **p1FromY** (float) - Required - point 1 image Y
- **p2FromX** (float) - Required - point 2 image X
- **p2FromY** (float) - Required - point 2 image Y
- **p3FromX** (float) - Required - point 3 image X
- **p3FromY** (float) - Required - point 3 image Y
- **p4FromX** (float) - Required - point 4 image X
- **p4FromY** (float) - Required - point 4 image Y

### Returns
- **BitMatrix** - representing a grid of points sampled from the image within a region defined by the "from" parameters

### Throws
- **NotFoundException** - if image can't be sampled, for example, if the transformation defined by the given points is invalid or results in sampling outside the image boundaries
```

--------------------------------

### get(int x, int y)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitMatrix.html

Gets the requested bit, where true means black.

```APIDOC
## get(int x, int y)

### Description
Gets the requested bit, where true means black.

### Method
`public boolean get(int x, int y)`

### Parameters
- `x` (int) - Required - The horizontal component (i.e. which column)
- `y` (int) - Required - The vertical component (i.e. which row)

### Returns
- `boolean` - value of given bit in matrix

```

--------------------------------

### subSequence(int start, int end)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/ECIInput.html

Returns a CharSequence that is a subsequence of this sequence from the start index (inclusive) to the end index (exclusive).

```APIDOC
## subSequence(int start, int end)

### Description
Returns a `CharSequence` that is a subsequence of this sequence. The subsequence starts with the `char` value at the specified index and ends with the `char` value at index `end - 1`. The length (in `char`s) of the returned sequence is `end - start`, so if `start == end` then an empty sequence is returned.

### Method
CharSequence subSequence(int start, int end)

### Signature
`CharSequence subSequence(int start, int end)`

### Parameters
- **start** (int) - The start index, inclusive.
- **end** (int) - The end index, exclusive.

### Returns
- **CharSequence** - the specified subsequence

### Throws
- **IndexOutOfBoundsException** - if `start` or `end` are negative, if `end` is greater than `length()`, or if `start` is greater than `end`
- **IllegalArgumentException** - if a value in the range `start`-`end` is an ECI (@see #isECI)
```

--------------------------------

### main(String[] args)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/j2se/GUIRunner.html

The entry point for the GUIRunner class. It launches the graphical interface for barcode decoding and may throw a MalformedURLException.

```APIDOC
## main(String[] args)

### Description
Starts the GUI runner for ZXing barcode decoding. This is the main entry point of the class.

### Signature
public static void main(String[] args) throws MalformedURLException

### Parameters
- **args** (String[]) - Required - Command-line arguments.

### Throws
- `MalformedURLException` - Thrown when a URL is malformed.

### Usage Example
```java
GUIRunner.main(new String[]{ "image.png" });
```
```

--------------------------------

### recordPattern(BitArray row, int start, int[] counters)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/oned/OneDReader.html

Records the size of successive runs of white and black pixels in a row, starting at a given point.

```APIDOC
## recordPattern(BitArray row, int start, int[] counters)

### Description
Records the size of successive runs of white and black pixels in a row, starting at a given point. The values are recorded in the given array, and the number of runs recorded is equal to the size of the array. If the row starts on a white pixel at the given start point, then the first count recorded is the run of white pixels starting from that point; likewise it is the count of a run of black pixels if the row begin on a black pixels at that point.

### Method
recordPattern

### Signature
`protected static void recordPattern(BitArray row, int start, int[] counters) throws NotFoundException`

### Parameters
- **row** (BitArray) - Required - row to count from
- **start** (int) - Required - offset into row to start at
- **counters** (int[]) - Required - array into which to record counts

### Throws
- `NotFoundException` - if counters cannot be filled entirely from row before running out of pixels
```

--------------------------------

### main(String[] args)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/j2se/CommandLineRunner.html

The main entry point for the command line utility. It decodes barcodes from the provided file, directory, or URI arguments, printing the raw text of each barcode and summary statistics when processing directories.

```APIDOC
## main(String[] args)

### Description
This is the main method of the CommandLineRunner class. It decodes barcodes from the provided file, directory, or URI arguments. By default, it uses normal decoding algorithms, but passing --try_harder enables the try harder hint. The raw text of each barcode is printed, and when running against directories, summary statistics are displayed.

### Method
public static void main(String[] args) throws Exception

### Parameters
- **args** (String[]) - Required - An array of command line arguments, which can be file paths, directory paths, or URIs to decode. Optionally, include --try_harder to request the try harder hint.

### Throws
- **Exception** - If an error occurs during decoding or processing of the input arguments.

### Request Example
```
java com.google.zxing.client.j2se.CommandLineRunner --try_harder /path/to/file.png
```

### Response
#### Success Response
- No explicit return value. The method prints the raw text of each decoded barcode to standard output. When processing directories, summary statistics are also printed.

#### Response Example
```
Barcode text: 1234567890
Summary: 1 file(s) processed, 1 barcode(s) found
```

```

--------------------------------

### getRowSize()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitMatrix.html

Gets the row size.

```APIDOC
## getRowSize()

### Description
Gets the row size.

### Method
`public int getRowSize()`

### Returns
- `int` - row size

```

--------------------------------

### ProductResultParser()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/result/ProductResultParser.html

Constructor for creating a ProductResultParser instance.

```APIDOC
## ProductResultParser()

### Description
Constructor for the ProductResultParser class.

### Method
Constructor

### Signature
`public ProductResultParser()`

### Parameters
None

### Returns
No return value (constructor).

```

--------------------------------

### getHeight()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitMatrix.html

Gets the height of the matrix.

```APIDOC
## getHeight()

### Description
Gets the height of the matrix.

### Method
`public int getHeight()`

### Returns
- `int` - height of the matrix

```

--------------------------------

### getWidth()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitMatrix.html

Gets the width of the matrix.

```APIDOC
## getWidth()

### Description
Gets the width of the matrix.

### Method
`public int getWidth()`

### Returns
- `int` - width of the matrix

```

--------------------------------

### Detector.processFinderPatternInfo(FinderPatternInfo)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/FormatException.html

Documentation for the Detector.processFinderPatternInfo method that throws FormatException.

```APIDOC
## Detector.processFinderPatternInfo(FinderPatternInfo)

### Description
Processes finder pattern information. This method throws FormatException if the information cannot be processed.

### Method
processFinderPatternInfo

### Signature
`protected final DetectorResult processFinderPatternInfo(FinderPatternInfo info)`

### Parameters
- **info** (FinderPatternInfo) - The finder pattern information.

### Returns
- **DetectorResult** - The detection result.

### Throws
- **FormatException** - If the information cannot be processed.
```

--------------------------------

### chooseMode(String content)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/qrcode/encoder/Encoder.html

Chooses the appropriate Mode for the given content.

```APIDOC
## chooseMode(String content)

### Description
Chooses the appropriate Mode for the given content.

### Method
static Mode chooseMode(String content)

### Parameters
- **content** (String) - Required - Content to analyze.

### Returns
- **Mode** - The chosen mode.
```

--------------------------------

### getBottomRightOnBit()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitMatrix.html

Gets the bottom-right on bit.

```APIDOC
## getBottomRightOnBit()

### Description
Gets the bottom-right on bit.

### Method
`public int[] getBottomRightOnBit()`

### Returns
- `int[]` - bottom-right on bit coordinates

```

--------------------------------

### PDF417()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/pdf417/encoder/PDF417.html

Constructs a new PDF417 instance with default settings.

```APIDOC
## Constructor: PDF417()

### Description
Constructs a new PDF417 instance with default settings.

### Method
Constructor

### Parameters
None

### Returns
A new PDF417 object.

```

--------------------------------

### decodeRow(int, BitArray, int[], Map)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/oned/UPCEANReader.html

Like decodeRow(int, BitArray, Map), but allows the caller to inform the method about where the UPC/EAN start pattern is found. This allows the start pattern to be computed once and reused across many implementations.

```APIDOC
## decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)

### Description
Like decodeRow(int, BitArray, Map), but allows caller to inform method about where the UPC/EAN start pattern is found. This allows this to be computed once and reused across many implementations.

### Method
public Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints) throws NotFoundException, ChecksumException, FormatException

### Parameters
- **rowNumber** (int) - Required - row index into the image
- **row** (BitArray) - Required - encoding of the row of the barcode image
- **startGuardRange** (int[]) - Required - start/end column where the opening start pattern was found
- **hints** (Map<DecodeHintType,?>) - Required - optional hints that influence decoding

### Returns
- **Result** - encapsulating the result of decoding a barcode in the row

### Throws
- **NotFoundException** - if no potential barcode is found
- **ChecksumException** - if a potential barcode is found but does not pass its checksum
- **FormatException** - if a potential barcode is found but format is invalid
```

--------------------------------

### QRCodeReader()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/qrcode/QRCodeReader.html

Constructor for creating a QRCodeReader instance.

```APIDOC
## Constructor: QRCodeReader()

### Description
Creates a new QRCodeReader instance.

### Method
Constructor

### Signature
`public QRCodeReader()`

```

--------------------------------

### PlanarYUVLuminanceSource Constructor

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/PlanarYUVLuminanceSource.html

Constructor for creating a PlanarYUVLuminanceSource from YUV camera data with optional cropping.

```APIDOC
## PlanarYUVLuminanceSource(byte[] yuvData, int dataWidth, int dataHeight, int left, int top, int width, int height, boolean reverseHorizontal)

### Description
Creates a new PlanarYUVLuminanceSource around an array of YUV data returned from the camera driver, with the option to crop to a rectangle within the full data.

### Constructor
`public PlanarYUVLuminanceSource(byte[] yuvData, int dataWidth, int dataHeight, int left, int top, int width, int height, boolean reverseHorizontal)`

### Parameters
- **yuvData** (byte[]) - Required - The YUV data array.
- **dataWidth** (int) - Required - The width of the full data.
- **dataHeight** (int) - Required - The height of the full data.
- **left** (int) - Required - The left coordinate of the crop rectangle.
- **top** (int) - Required - The top coordinate of the crop rectangle.
- **width** (int) - Required - The width of the crop rectangle.
- **height** (int) - Required - The height of the crop rectangle.
- **reverseHorizontal** (boolean) - Required - Whether to reverse the image horizontally.
```

--------------------------------

### FinderPatternFinder(BitMatrix image, ResultPointCallback resultPointCallback)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/qrcode/detector/FinderPatternFinder.html

Creates a finder with a result point callback.

```APIDOC
## FinderPatternFinder(BitMatrix image, ResultPointCallback resultPointCallback)

### Description
Creates a finder with a result point callback.

### Constructor
`public FinderPatternFinder(BitMatrix image, ResultPointCallback resultPointCallback)`

### Parameters
- **image** (BitMatrix) - Required - image to search
- **resultPointCallback** (ResultPointCallback) - Required - callback for result points

```

--------------------------------

### Methods in com.google.zxing.multi with DecodeHintType Hints

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/DecodeHintType.html

Methods in com.google.zxing.multi that accept a Map of DecodeHintType hints.

```APIDOC
## ByQuadrantReader.decode(BinaryBitmap image, Map<DecodeHintType,?> hints)

### Description
Decodes an image by quadrant using the provided hints.

### Method
decode

### Signature
`Result decode(BinaryBitmap image, Map<DecodeHintType,?> hints)`

### Parameters
- **image** (BinaryBitmap) - Required - The image to decode.
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in decoding.

### Returns
- **Result** - The decoded result.
```

```APIDOC
## GenericMultipleBarcodeReader.decodeMultiple(BinaryBitmap image, Map<DecodeHintType,?> hints)

### Description
Decodes multiple barcodes from an image using the provided hints.

### Method
decodeMultiple

### Signature
`Result[] decodeMultiple(BinaryBitmap image, Map<DecodeHintType,?> hints)`

### Parameters
- **image** (BinaryBitmap) - Required - The image to decode.
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in decoding.

### Returns
- **Result[]** - An array of decoded results.
```

```APIDOC
## MultipleBarcodeReader.decodeMultiple(BinaryBitmap image, Map<DecodeHintType,?> hints)

### Description
Decodes multiple barcodes from an image using the provided hints.

### Method
decodeMultiple

### Signature
`Result[] decodeMultiple(BinaryBitmap image, Map<DecodeHintType,?> hints)`

### Parameters
- **image** (BinaryBitmap) - Required - The image to decode.
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in decoding.

### Returns
- **Result[]** - An array of decoded results.
```

--------------------------------

### get(int i)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitArray.html

Returns the value of the bit at the specified index.

```APIDOC
## get(int i)

### Description
Returns the value of the bit at the specified index.

### Method
public boolean get(int i)

### Parameters
- **i** (int) - Required - The index of the bit to get.

### Returns
- **boolean** - true iff bit i is set.
```

--------------------------------

### ByteMatrix(int width, int height)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/qrcode/encoder/ByteMatrix.html

Constructor that creates a ByteMatrix with the specified width and height.

```APIDOC
## ByteMatrix(int width, int height)

### Description
Creates a new ByteMatrix with the given dimensions.

### Constructor
`public ByteMatrix(int width, int height)`

### Parameters
- **width** (int) - Required - The width of the matrix.
- **height** (int) - Required - The height of the matrix.

```

--------------------------------

### setRange(int start, int end)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitArray.html

Sets a range of bits.

```APIDOC
## setRange(int start, int end)

### Description
Sets a range of bits.

### Method
public void setRange(int start, int end)

### Parameters
- **start** (int) - Required - The start of the range, inclusive.
- **end** (int) - Required - The end of the range, exclusive.

### Returns
No return value.
```

--------------------------------

### public static GridSampler getInstance()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/GridSampler.html

Returns the current implementation of GridSampler.

```APIDOC
## public static GridSampler getInstance()

### Description
Returns the current implementation of GridSampler.

### Method
Static method

### Signature
`public static GridSampler getInstance()`

### Returns
- **GridSampler** - The current implementation of GridSampler.

```

--------------------------------

### get(int x, int y)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/qrcode/encoder/ByteMatrix.html

Returns the byte value at the specified position.

```APIDOC
## get(int x, int y)

### Description
Returns the byte value at the specified coordinates.

### Method
`public byte get(int x, int y)`

### Parameters
- **x** (int) - Required - The x-coordinate.
- **y** (int) - Required - The y-coordinate.

### Returns
- **byte** - The value at the specified position.

```

--------------------------------

### Methods in com.google.zxing.multi.qrcode.detector with DecodeHintType Hints

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/DecodeHintType.html

Methods in com.google.zxing.multi.qrcode.detector that accept a Map of DecodeHintType hints.

```APIDOC
## MultiDetector.detectMulti(Map<DecodeHintType,?> hints)

### Description
Detects multiple barcodes using the provided hints.

### Method
detectMulti

### Signature
`DetectorResult[] detectMulti(Map<DecodeHintType,?> hints)`

### Parameters
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in detection.

### Returns
- **DetectorResult[]** - An array of detected results.
```

```APIDOC
## MultiFinderPatternFinder.findMulti(Map<DecodeHintType,?> hints)

### Description
Finds multiple finder patterns using the provided hints.

### Method
findMulti

### Signature
`FinderPatternInfo[] findMulti(Map<DecodeHintType,?> hints)`

### Parameters
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in finding.

### Returns
- **FinderPatternInfo[]** - An array of finder pattern information.
```

--------------------------------

### getNextUnset(int from)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitArray.html

Returns the index of the next unset bit, starting from the given index.

```APIDOC
## getNextUnset(int from)

### Description
Returns the index of the next unset bit, starting from the given index.

### Method
public int getNextUnset(int from)

### Parameters
- **from** (int) - Required - The index to start looking for unset bit.

### Returns
- **int** - Index of next unset bit, or `size` if none are unset until the end.

### See Also
- `getNextSet(int)`
```

--------------------------------

### sampleGrid(BitMatrix image, int dimensionX, int dimensionY, PerspectiveTransform transform)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/DefaultGridSampler.html

Samples an image for a rectangular matrix of bits of the given dimension using a PerspectiveTransform.

```APIDOC
## sampleGrid(BitMatrix image, int dimensionX, int dimensionY, PerspectiveTransform transform)

### Description
Samples an image for a rectangular matrix of bits of the given dimension using a PerspectiveTransform.

### Method
sampleGrid

### Signature
`public BitMatrix sampleGrid(BitMatrix image, int dimensionX, int dimensionY, PerspectiveTransform transform) throws NotFoundException`

### Parameters
- **image** (BitMatrix) - Required - image to sample
- **dimensionX** (int) - Required - width of BitMatrix to sample from image
- **dimensionY** (int) - Required - height of BitMatrix to sample from image
- **transform** (PerspectiveTransform) - Required - the perspective transform to apply

### Returns
- **BitMatrix** - representing a grid of points sampled from the image

### Throws
- **NotFoundException** - if image can't be sampled
```

--------------------------------

### getNextSet(int from)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitArray.html

Returns the index of the first bit that is set, starting from the given index.

```APIDOC
## getNextSet(int from)

### Description
Returns the index of the first bit that is set, starting from the given index.

### Method
public int getNextSet(int from)

### Parameters
- **from** (int) - Required - The first bit to check.

### Returns
- **int** - Index of first bit that is set, or size if none are set at or beyond this given index.

### See Also
- `getNextUnset(int)`
```

--------------------------------

### Constructor MultiFormatOneDReader(Map<DecodeHintType,?> hints)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/oned/MultiFormatOneDReader.html

Creates a new MultiFormatOneDReader instance with the specified decode hints.

```APIDOC
## Constructor MultiFormatOneDReader

### Description
Creates a new MultiFormatOneDReader instance with the specified decode hints.

### Constructor
`public MultiFormatOneDReader(Map<DecodeHintType,?> hints)`

### Parameters
- **hints** (Map<DecodeHintType,?>) - Required - Decode hints to configure the reader.
```

--------------------------------

### recordPatternInReverse(BitArray row, int start, int[] counters)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/oned/OneDReader.html

Records the pattern in reverse.

```APIDOC
## recordPatternInReverse(BitArray row, int start, int[] counters)

### Description
Records the pattern in reverse.

### Method
recordPatternInReverse

### Signature
`protected static void recordPatternInReverse(BitArray row, int start, int[] counters) throws NotFoundException`

### Parameters
- **row** (BitArray) - Required - row to count from
- **start** (int) - Required - offset into row to start at
- **counters** (int[]) - Required - array into which to record counts

### Throws
- `NotFoundException`
```

--------------------------------

### setBulk(int i, int newBits)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitArray.html

Sets a block of 32 bits, starting at bit i.

```APIDOC
## setBulk(int i, int newBits)

### Description
Sets a block of 32 bits, starting at bit i.

### Method
public void setBulk(int i, int newBits)

### Parameters
- **i** (int) - Required - The first bit to set.
- **newBits** (int) - Required - The new value of the next 32 bits. The least-significant bit corresponds to bit i, the next-least-significant to i+1, and so on.

### Returns
No return value.
```

--------------------------------

### BookmarkDoCoMoResultParser()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/result/BookmarkDoCoMoResultParser.html

Constructor for the BookmarkDoCoMoResultParser class.

```APIDOC
## Constructor: BookmarkDoCoMoResultParser()

### Description
Creates a new instance of the BookmarkDoCoMoResultParser class.

### Signature
`public BookmarkDoCoMoResultParser()`

### Parameters
None.

### Returns
No return value.
```

--------------------------------

### isRange(int start, int end, boolean value)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitArray.html

Efficiently checks if a range of bits is set, or not set.

```APIDOC
## isRange(int start, int end, boolean value)

### Description
Efficiently checks if a range of bits is set, or not set.

### Method
public boolean isRange(int start, int end, boolean value)

### Parameters
- **start** (int) - Required - The start of the range, inclusive.
- **end** (int) - Required - The end of the range, exclusive.
- **value** (boolean) - Required - If true, checks that bits in range are set, otherwise checks that they are not set.

### Returns
- **boolean** - true iff all bits are set or not set in range, according to value argument.

### Throws
- **IllegalArgumentException** - If end is less than start or the range is not contained in the array.
```

--------------------------------

### public GridSampler()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/GridSampler.html

Constructs a GridSampler instance.

```APIDOC
## public GridSampler()

### Description
Constructs a new GridSampler object.

### Method
Constructor

### Signature
`public GridSampler()`

```

--------------------------------

### FinderPatternFinder(BitMatrix image)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/qrcode/detector/FinderPatternFinder.html

Creates a finder that will search the image for three finder patterns.

```APIDOC
## FinderPatternFinder(BitMatrix image)

### Description
Creates a finder that will search the image for three finder patterns.

### Constructor
`public FinderPatternFinder(BitMatrix image)`

### Parameters
- **image** (BitMatrix) - Required - image to search

```

--------------------------------

### haveNCharacters(int index, int n)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/ECIInput.html

Checks if the input has at least n characters available starting from the specified index.

```APIDOC
## haveNCharacters(int index, int n)

### Description
Checks if the input has at least `n` characters available starting from the specified index.

### Method
boolean haveNCharacters(int index, int n)

### Signature
`boolean haveNCharacters(int index, int n)`

### Parameters
- **index** (int) - The starting index.
- **n** (int) - The number of characters to check.

### Returns
- **boolean** - true if the input has at least `n` characters from `index`, false otherwise.

### Throws
- No exceptions are documented.
```

--------------------------------

### public static void setGridSampler(GridSampler newGridSampler)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/GridSampler.html

Sets the global implementation of GridSampler used by the library. This allows platform-specific implementations to be installed.

```APIDOC
## public static void setGridSampler(GridSampler newGridSampler)

### Description
Sets the implementation of GridSampler used by the library. One global instance is stored, which may sound problematic. But, the implementation provided ought to be appropriate for the entire platform, and all uses of this library in the whole lifetime of the JVM. For instance, an Android activity can swap in an implementation that takes advantage of native platform libraries.

### Method
Static method

### Signature
`public static void setGridSampler(GridSampler newGridSampler)`

### Parameters
- **newGridSampler** (GridSampler) - Required - The platform-specific object to install.

```

--------------------------------

### toBytes(int bitOffset, byte[] array, int offset, int numBytes)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitArray.html

Writes the bits to a byte array, starting at the specified bit offset.

```APIDOC
## toBytes(int bitOffset, byte[] array, int offset, int numBytes)

### Description
Writes the bits to a byte array, starting at the specified bit offset.

### Method
public void toBytes(int bitOffset, byte[] array, int offset, int numBytes)

### Parameters
- **bitOffset** (int) - Required - The first bit to start writing.
- **array** (byte[]) - Required - The array to write into. Bytes are written most-significant byte first.
- **offset** (int) - Required - The position in array to start writing.
- **numBytes** (int) - Required - How many bytes to write.

### Returns
No return value.
```

--------------------------------

### QRCodeReader.decode(BinaryBitmap)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/FormatException.html

Documentation for the QRCodeReader.decode method that throws FormatException.

```APIDOC
## QRCodeReader.decode(BinaryBitmap)

### Description
Locates and decodes a QR code in an image. This method throws FormatException if the code cannot be decoded.

### Method
decode

### Signature
`Result decode(BinaryBitmap image)`

### Parameters
- **image** (BinaryBitmap) - The image to decode.

### Returns
- **Result** - The decoded result.

### Throws
- **FormatException** - If the code cannot be decoded.
```

--------------------------------

### decodeMiddle(BitArray row, int[] startRange, StringBuilder resultString)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/oned/EAN13Reader.html

Decodes the portion of a barcode between the start and end guard patterns. This method is protected and intended to be overridden by subclasses.

```APIDOC
## decodeMiddle(BitArray row, int[] startRange, StringBuilder resultString)

### Description
Subclasses override this to decode the portion of a barcode between the start and end guard patterns. This method is called during the decoding process to extract the middle section of the barcode.

### Method
`protected int decodeMiddle(BitArray row, int[] startRange, StringBuilder resultString) throws NotFoundException`

### Parameters
- **row** (BitArray) - Required - Row of black/white values to search.
- **startRange** (int[]) - Required - Start/end offset of start guard pattern.
- **resultString** (StringBuilder) - Required - StringBuilder to append decoded chars to.

### Returns
Horizontal offset of first pixel after the "middle" that was decoded.

### Throws
- **NotFoundException** - If decoding could not complete successfully.
```

--------------------------------

### getPhase2Method()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/result/WifiParsedResult.html

Returns the phase 2 method of the WiFi network.

```APIDOC
## getPhase2Method()

### Description
Retrieves the phase 2 method used by the WiFi network.

### Returns
- **String** - The phase 2 method of the WiFi network.

```

--------------------------------

### encode(String contents)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/oned/Code128Writer.html

Encodes the given barcode contents into a boolean array representing a one-dimensional barcode. The result includes start and end codes but excludes side margins.

```APIDOC
## encode(String contents)

### Description
Encodes the given barcode contents into a boolean array representing a one-dimensional barcode. The result includes start and end codes but excludes side margins.

### Method
`public boolean[] encode(String contents)`

### Parameters
- **contents** (String) - Required - The barcode contents to encode.

### Returns
A `boolean[]` of horizontal pixels (false = white, true = black).
```

--------------------------------

### BitMatrix(int width, int height)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/common/BitMatrix.html

Creates an empty BitMatrix with the specified width and height.

```APIDOC
## BitMatrix(int width, int height)

### Description
Creates an empty BitMatrix.

### Constructor
`public BitMatrix(int width, int height)`

### Parameters
- `width` (int) - Required - bit matrix width
- `height` (int) - Required - bit matrix height

```

--------------------------------

### UPCAReader.decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/ChecksumException.html

Decodes a row of a UPCA barcode with start guard range. Throws ChecksumException if checksum fails.

```APIDOC
## UPCAReader.decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)

### Description
Decodes a row of a UPCA barcode with start guard range. Throws ChecksumException if checksum fails.

### Method
`Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)`

### Parameters
- `rowNumber` (int) - The row number.
- `row` (BitArray) - The row data.
- `startGuardRange` (int[]) - The start guard range.
- `hints` (Map<DecodeHintType,?>) - Optional hints.

### Returns
- `Result` - The decoded result.

### Throws
- `ChecksumException` - If the checksum fails.
```

--------------------------------

### StringUtils Methods with DecodeHintType Hints

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/DecodeHintType.html

Static methods in com.google.zxing.common that accept a Map of DecodeHintType hints.

```APIDOC
## StringUtils.guessCharset(byte[] bytes, Map<DecodeHintType,?> hints)

### Description
Guesses the charset of the given bytes using the provided hints.

### Method
guessCharset

### Signature
`static Charset guessCharset(byte[] bytes, Map<DecodeHintType,?> hints)`

### Parameters
- **bytes** (byte[]) - Required - The bytes to analyze.
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in guessing.

### Returns
- **Charset** - The guessed charset.
```

```APIDOC
## StringUtils.guessEncoding(byte[] bytes, Map<DecodeHintType,?> hints)

### Description
Guesses the encoding of the given bytes using the provided hints.

### Method
guessEncoding

### Signature
`static String guessEncoding(byte[] bytes, Map<DecodeHintType,?> hints)`

### Parameters
- **bytes** (byte[]) - Required - The bytes to analyze.
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in guessing.

### Returns
- **String** - The guessed encoding.
```

--------------------------------

### Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/oned/UPCAReader.html

Decodes a row of pixel data with a known start guard range, returning the decoded barcode result.

```APIDOC
## Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)

### Description
Like `UPCEANReader.decodeRow(int, BitArray, Map)`, but allows caller to inform method about where the UPC/EAN start pattern is found. This allows this to be computed once and reused across many implementations.

### Method
Method

### Signature
`public Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints) throws NotFoundException, FormatException, ChecksumException`

### Parameters
- **rowNumber** (int) - row index into the image
- **row** (BitArray) - encoding of the row of the barcode image
- **startGuardRange** (int[]) - start/end column where the opening start pattern was found
- **hints** (Map<DecodeHintType,?>) - optional hints that influence decoding

### Returns
`Result` encapsulating the result of decoding a barcode in the row

### Throws
- `NotFoundException` - if no potential barcode is found
- `FormatException` - if a potential barcode is found but format is invalid
- `ChecksumException` - if a potential barcode is found but does not pass its checksum

```

--------------------------------

### writeToPath(BitMatrix matrix, String format, Path file)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/j2se/MatrixToImageWriter.html

Writes a BitMatrix to a file with default configuration.

```APIDOC
## writeToPath(BitMatrix matrix, String format, Path file)

### Description
Writes a `BitMatrix` to a file with default configuration.

### Method
`static void writeToPath(BitMatrix matrix, String format, Path file)`

### Parameters
- **matrix** (BitMatrix) - Required - The bit matrix to write.
- **format** (String) - Required - The image format (e.g., "png").
- **file** (Path) - Required - The path to the file to write.

```

--------------------------------

### UPCEANReader.decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/ChecksumException.html

Like UPCEANReader.decodeRow(int, BitArray, Map), but allows caller to inform method about where the UPC/EAN start pattern is found. Throws ChecksumException if checksum fails.

```APIDOC
## UPCEANReader.decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)

### Description
Like UPCEANReader.decodeRow(int, BitArray, Map), but allows caller to inform method about where the UPC/EAN start pattern is found. Throws ChecksumException if checksum fails.

### Method
`Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange, Map<DecodeHintType,?> hints)`

### Parameters
- `rowNumber` (int) - The row number.
- `row` (BitArray) - The row data.
- `startGuardRange` (int[]) - The start guard range.
- `hints` (Map<DecodeHintType,?>) - Optional hints.

### Returns
- `Result` - The decoded result.

### Throws
- `ChecksumException` - If the checksum fails.
```

--------------------------------

### Methods in com.google.zxing with DecodeHintType Hints

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/class-use/DecodeHintType.html

Methods in com.google.zxing that accept a Map of DecodeHintType hints.

```APIDOC
## MultiFormatReader.decode(BinaryBitmap image, Map<DecodeHintType,?> hints)

### Description
Decode an image using the hints provided.

### Method
decode

### Signature
`Result decode(BinaryBitmap image, Map<DecodeHintType,?> hints)`

### Parameters
- **image** (BinaryBitmap) - Required - The image to decode.
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in decoding.

### Returns
- **Result** - The decoded result.
```

```APIDOC
## Reader.decode(BinaryBitmap image, Map<DecodeHintType,?> hints)

### Description
Locates and decodes a barcode in some format within an image.

### Method
decode

### Signature
`Result decode(BinaryBitmap image, Map<DecodeHintType,?> hints)`

### Parameters
- **image** (BinaryBitmap) - Required - The image to decode.
- **hints** (Map<DecodeHintType,?>) - Required - Hints to aid in decoding.

### Returns
- **Result** - The decoded result.
```

```APIDOC
## MultiFormatReader.setHints(Map<DecodeHintType,?> hints)

### Description
This method adds state to the MultiFormatReader.

### Method
setHints

### Signature
`void setHints(Map<DecodeHintType,?> hints)`

### Parameters
- **hints** (Map<DecodeHintType,?>) - Required - Hints to set.
```

--------------------------------

### handlePossibleCenter(int[] stateCount, int i, int j, boolean pureBarcode)

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/qrcode/detector/FinderPatternFinder.html

Deprecated. Only exists for backwards compatibility. Cross checks with a vertical scan and adds finder pattern candidate if successful.

```APIDOC
## handlePossibleCenter(int[] stateCount, int i, int j, boolean pureBarcode)

### Description
Deprecated. Only exists for backwards compatibility. Cross checks with a vertical scan and adds finder pattern candidate if successful.

### Method
`@Deprecated protected final boolean handlePossibleCenter(int[] stateCount, int i, int j, boolean pureBarcode)`

### Parameters
- **stateCount** (int[]) - Required - reading state module counts from horizontal scan
- **i** (int) - Required - row where finder pattern may be found
- **j** (int) - Required - end of possible finder pattern in row
- **pureBarcode** (boolean) - Required - ignored

### Returns
- **boolean** - true if a finder pattern candidate was found this time

### See Also
- `handlePossibleCenter(int[], int, int)`

```

--------------------------------

### getEapMethod()

Source: https://zxing.github.io/zxing/apidocs/com/google/zxing/client/result/WifiParsedResult.html

Returns the EAP method of the WiFi network.

```APIDOC
## getEapMethod()

### Description
Retrieves the EAP method used by the WiFi network.

### Returns
- **String** - The EAP method of the WiFi network.

```
Tokens:
Raw