Class BarcodeScannerAdditionalConfig
-
- All Implemented Interfaces:
public final class BarcodeScannerAdditionalConfig
Entity represents additional configuration params for ScanbotBarcodeDetector.
Note: only a few barcode types support these params - for the rest these settings will have no influence. Please read each param documentation carefully before modifying.
Note: in future these params might change their behavior. If you you use non-default values in your code please read changelogs of future versions carefully to avoid subtle changes in application logic.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
BarcodeScannerAdditionalConfig.Companion
-
Field Summary
Fields Modifier and Type Field Description public final static Integer
DEFAULT_MIN_TEXT_LENGTH
public final static Integer
DEFAULT_MAX_TEXT_LENGTH
public final static Integer
DEFAULT_MIN_1D_QUIET_ZONE_SIZE
public final static Boolean
DEFAULT_USE_IATA_2_OF_5_CHECKSUM
public final static Boolean
DEFAULT_USE_CODE_11_CHECKSUM
public final static Boolean
DEFAULT_STRIP_CHECK_DIGITS
public final static Boolean
DEFAULT_LOW_POWER_MODE
private final Integer
minimumTextLength
private final Integer
maximumTextLength
private final Integer
minimum1DQuietZoneSize
private final Gs1Handling
gs1Handling
private final EnumSet<MSIPlesseyChecksumAlgorithm>
msiPlesseyChecksumAlgorithms
private final Boolean
stripCheckDigits
private final Boolean
lowPowerMode
private final Boolean
useIata2Of5Checksum
private final Boolean
useCode11Checksum
private final AustraliaPostCustomerFormat
australiaPostCustomerFormat
public final static BarcodeScannerAdditionalConfig.Companion
Companion
-
Constructor Summary
Constructors Constructor Description BarcodeScannerAdditionalConfig(Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Gs1Handling gs1Handling, EnumSet<MSIPlesseyChecksumAlgorithm> msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, AustraliaPostCustomerFormat australiaPostCustomerFormat)
-
Method Summary
Modifier and Type Method Description final Integer
getMinimumTextLength()
Minimum required text length of the detected barcode. final Integer
getMaximumTextLength()
Maximum text length of the detected barcode. final Integer
getMinimum1DQuietZoneSize()
Minimum required quiet zone on the barcode. final Gs1Handling
getGs1Handling()
GS1 handling mode. final EnumSet<MSIPlesseyChecksumAlgorithm>
getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. final Boolean
getStripCheckDigits()
If true
, check digits for UPC, EAN and MSI Plessey codes are removed from result.final Boolean
getLowPowerMode()
If true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed.final Boolean
getUseIata2Of5Checksum()
If true
, the IATA 2 of 5 barcode checksum is used.final Boolean
getUseCode11Checksum()
If true
, the Code 11 barcode checksum is used.final AustraliaPostCustomerFormat
getAustraliaPostCustomerFormat()
The australia post customer format. -
-
Constructor Detail
-
BarcodeScannerAdditionalConfig
BarcodeScannerAdditionalConfig(Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Gs1Handling gs1Handling, EnumSet<MSIPlesseyChecksumAlgorithm> msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, AustraliaPostCustomerFormat australiaPostCustomerFormat)
-
-
Method Detail
-
getMinimumTextLength
final Integer getMinimumTextLength()
Minimum required text length of the detected barcode. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getMaximumTextLength
final Integer getMaximumTextLength()
Maximum text length of the detected barcode. Setting to zero removes the limit. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getMinimum1DQuietZoneSize
final Integer getMinimum1DQuietZoneSize()
Minimum required quiet zone on the barcode. Measured in modules (the size of a minimal bar on the barcode). The default value is 10. NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getGs1Handling
final Gs1Handling getGs1Handling()
GS1 handling mode.
-
getMsiPlesseyChecksumAlgorithms
final EnumSet<MSIPlesseyChecksumAlgorithm> getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. The default value is MSIPlesseyChecksumAlgorithm.Mod10.
-
getStripCheckDigits
final Boolean getStripCheckDigits()
If
true
, check digits for UPC, EAN and MSI Plessey codes are removed from result. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default isfalse
-
getLowPowerMode
final Boolean getLowPowerMode()
If
true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. Iffalse
- mode is disabled. The default isfalse
-
getUseIata2Of5Checksum
final Boolean getUseIata2Of5Checksum()
If
true
, the IATA 2 of 5 barcode checksum is used. Default istrue
-
getUseCode11Checksum
final Boolean getUseCode11Checksum()
If
true
, the Code 11 barcode checksum is used. Default istrue
-
getAustraliaPostCustomerFormat
final AustraliaPostCustomerFormat getAustraliaPostCustomerFormat()
The australia post customer format. The default value is AustraliaPostCustomerFormat.ALPHA_NUMERIC.
-
-
-
-