Class BarcodeScannerAdditionalConfiguration
-
- All Implemented Interfaces:
public final class BarcodeScannerAdditionalConfigurationEntity represents additional configuration params for BarcodeScanner.
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.
-
-
Field Summary
Fields Modifier and Type Field Description private final IntegerminimumTextLengthprivate final IntegermaximumTextLengthprivate final Integerminimum1DQuietZoneSizeprivate final Gs1Handlinggs1HandlingModeprivate final List<MsiPlesseyChecksumAlgorithm>msiPlesseyChecksumAlgorithmsprivate final BooleanstripCheckDigitsprivate final BooleanlowPowerModeprivate final BooleanuseIata2Of5Checksumprivate final BooleanuseCode11Checksumprivate final AustraliaPostCustomerFormataustraliaPostCustomerFormat
-
Constructor Summary
Constructors Constructor Description BarcodeScannerAdditionalConfiguration(Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Gs1Handling gs1HandlingMode, List<MsiPlesseyChecksumAlgorithm> msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, AustraliaPostCustomerFormat australiaPostCustomerFormat)
-
Method Summary
Modifier and Type Method Description final IntegergetMinimumTextLength()Minimum required text length of the scanned barcode. final IntegergetMaximumTextLength()Maximum text length of the scanned barcode. final IntegergetMinimum1DQuietZoneSize()Minimum required quiet zone on the barcode. final Gs1HandlinggetGs1HandlingMode()GS1 handling mode. final List<MsiPlesseyChecksumAlgorithm>getMsiPlesseyChecksumAlgorithms()The checksum algorithms for MSI Plessey barcodes. final BooleangetStripCheckDigits()If true, check digits for UPC, EAN and MSI Plessey codes are removed from result. final BooleangetLowPowerMode()If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed.final BooleangetUseIata2Of5Checksum()final BooleangetUseCode11Checksum()final AustraliaPostCustomerFormatgetAustraliaPostCustomerFormat()-
-
Constructor Detail
-
BarcodeScannerAdditionalConfiguration
BarcodeScannerAdditionalConfiguration(Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Gs1Handling gs1HandlingMode, List<MsiPlesseyChecksumAlgorithm> msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, AustraliaPostCustomerFormat australiaPostCustomerFormat)
-
-
Method Detail
-
getMinimumTextLength
final Integer getMinimumTextLength()
Minimum required text length of the scanned 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 scanned 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!
-
getGs1HandlingMode
final Gs1Handling getGs1HandlingMode()
GS1 handling mode. The default is Gs1Handling.PARSE.
-
getMsiPlesseyChecksumAlgorithms
final List<MsiPlesseyChecksumAlgorithm> getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. The default value is MsiPlesseyChecksumAlgorithm.MOD_10.
-
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 is
false
-
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()
-
getUseCode11Checksum
final Boolean getUseCode11Checksum()
-
getAustraliaPostCustomerFormat
final AustraliaPostCustomerFormat getAustraliaPostCustomerFormat()
-
-
-
-