All Implemented Interfaces:: android.os.Parcelable


public final class BarcodeFormatUpcEanConfiguration
extends BarcodeFormatOneDConfigurationBase implements Parcelable

UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`_type`
`private String`	`regexFilter`
`private Double`	`minimumSizeScore`
`private Boolean`	`addAdditionalQuietZone`
`private Integer`	`minimum1DQuietZoneSize`
`private Boolean`	`stripCheckDigits`
`private Boolean`	`ean8`
`private Boolean`	`ean13`
`private Boolean`	`upca`
`private Boolean`	`upce`
`private UpcEanExtensionBehavior`	`extensions`

Constructor Summary

Constructors
Constructor	Description
`BarcodeFormatUpcEanConfiguration(Map<String, Object> source)`
`BarcodeFormatUpcEanConfiguration(JSONObject json)`
`BarcodeFormatUpcEanConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Integer minimum1DQuietZoneSize, Boolean stripCheckDigits, Boolean ean8, Boolean ean13, Boolean upca, Boolean upce, UpcEanExtensionBehavior extensions)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`get_type()`
`String`	`getRegexFilter()`	Regular expression filter for barcode text.
`Unit`	`setRegexFilter(String regexFilter)`	Regular expression filter for barcode text.
`Double`	`getMinimumSizeScore()`	Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1).
`Unit`	`setMinimumSizeScore(Double minimumSizeScore)`	Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1).
`Boolean`	`getAddAdditionalQuietZone()`	If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
`Unit`	`setAddAdditionalQuietZone(Boolean addAdditionalQuietZone)`	If true, we process the barcode scanning with an artificial quiet zone that we add to the input image.
`Integer`	`getMinimum1DQuietZoneSize()`	Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
`Unit`	`setMinimum1DQuietZoneSize(Integer minimum1DQuietZoneSize)`	Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules.
`final Boolean`	`getStripCheckDigits()`	If true, the check digits are stripped from the result.
`final Unit`	`setStripCheckDigits(Boolean stripCheckDigits)`	If true, the check digits are stripped from the result.
`final Boolean`	`getEan8()`	If true, scan and return valid EAN-8 barcodes.
`final Unit`	`setEan8(Boolean ean8)`	If true, scan and return valid EAN-8 barcodes.
`final Boolean`	`getEan13()`	If true, scan and return valid EAN-13 barcodes.
`final Unit`	`setEan13(Boolean ean13)`	If true, scan and return valid EAN-13 barcodes.
`final Boolean`	`getUpca()`	If true, scan and return valid UPC-A barcodes.
`final Unit`	`setUpca(Boolean upca)`	If true, scan and return valid UPC-A barcodes.
`final Boolean`	`getUpce()`	If true, scan and return valid UPC-E barcodes.
`final Unit`	`setUpce(Boolean upce)`	If true, scan and return valid UPC-E barcodes.
`final UpcEanExtensionBehavior`	`getExtensions()`	Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
`final Unit`	`setExtensions(UpcEanExtensionBehavior extensions)`	Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
`JSONObject`	`toJson(ToJsonConfiguration config)`
`BarcodeFormatUpcEanConfiguration`	`clone()`
`final static BarcodeFormatUpcEanConfiguration`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BarcodeFormatUpcEanConfiguration
```
BarcodeFormatUpcEanConfiguration(Map<String, Object> source)
```
  - BarcodeFormatUpcEanConfiguration
```
BarcodeFormatUpcEanConfiguration(JSONObject json)
```
  - BarcodeFormatUpcEanConfiguration
```
BarcodeFormatUpcEanConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Integer minimum1DQuietZoneSize, Boolean stripCheckDigits, Boolean ean8, Boolean ean13, Boolean upca, Boolean upce, UpcEanExtensionBehavior extensions)
```
- Method Detail
  - get_type
```
 String get_type()
```
  - getRegexFilter
```
 String getRegexFilter()
```
    Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
    Default is ""
  - setRegexFilter
```
 Unit setRegexFilter(String regexFilter)
```
    Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
    Default is ""
  - getMinimumSizeScore
```
 Double getMinimumSizeScore()
```
    Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
    Default is 0
  - setMinimumSizeScore
```
 Unit setMinimumSizeScore(Double minimumSizeScore)
```
    Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
    Default is 0
  - getAddAdditionalQuietZone
```
 Boolean getAddAdditionalQuietZone()
```
    If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
    Default is false
  - setAddAdditionalQuietZone
```
 Unit setAddAdditionalQuietZone(Boolean addAdditionalQuietZone)
```
    If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
    Default is false
  - getMinimum1DQuietZoneSize
```
 Integer getMinimum1DQuietZoneSize()
```
    Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
    Default is 6
  - setMinimum1DQuietZoneSize
```
 Unit setMinimum1DQuietZoneSize(Integer minimum1DQuietZoneSize)
```
    Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
    Default is 6
  - getStripCheckDigits
```
 final Boolean getStripCheckDigits()
```
    If true, the check digits are stripped from the result.
    Default is false
  - setStripCheckDigits
```
 final Unit setStripCheckDigits(Boolean stripCheckDigits)
```
    If true, the check digits are stripped from the result.
    Default is false
  - getEan8
```
 final Boolean getEan8()
```
    If true, scan and return valid EAN-8 barcodes.
    Default is true
  - setEan8
```
 final Unit setEan8(Boolean ean8)
```
    If true, scan and return valid EAN-8 barcodes.
    Default is true
  - getEan13
```
 final Boolean getEan13()
```
    If true, scan and return valid EAN-13 barcodes.
    Default is true
  - setEan13
```
 final Unit setEan13(Boolean ean13)
```
    If true, scan and return valid EAN-13 barcodes.
    Default is true
  - getUpca
```
 final Boolean getUpca()
```
    If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes.
    Default is true
  - setUpca
```
 final Unit setUpca(Boolean upca)
```
    If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes.
    Default is true
  - getUpce
```
 final Boolean getUpce()
```
    If true, scan and return valid UPC-E barcodes.
    Default is true
  - setUpce
```
 final Unit setUpce(Boolean upce)
```
    If true, scan and return valid UPC-E barcodes.
    Default is true
  - getExtensions
```
 final UpcEanExtensionBehavior getExtensions()
```
    Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
    Default is ALLOW_ANY
  - setExtensions
```
 final Unit setExtensions(UpcEanExtensionBehavior extensions)
```
    Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
    Default is ALLOW_ANY
  - toJson
```
 JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 BarcodeFormatUpcEanConfiguration clone()
```
  - default
```
 final static BarcodeFormatUpcEanConfiguration default()
```

Class BarcodeFormatUpcEanConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BarcodeFormatUpcEanConfiguration

BarcodeFormatUpcEanConfiguration

BarcodeFormatUpcEanConfiguration

Method Detail

get_type

getRegexFilter

setRegexFilter

getMinimumSizeScore

setMinimumSizeScore

getAddAdditionalQuietZone

setAddAdditionalQuietZone

getMinimum1DQuietZoneSize

setMinimum1DQuietZoneSize

getStripCheckDigits

setStripCheckDigits

getEan8

setEan8

getEan13

setEan13

getUpca

setUpca

getUpce

setUpce

getExtensions

setExtensions

toJson

clone

default