Index
All Classes and Interfaces|All Packages|Serialized Form
A
- Android Mobile App Quick Start - Search tag in package org.gs1.gs1encoders
- Section
B
- Barcode scan data processing - Search tag in package org.gs1.gs1encoders
- Section
- Building the Java wrapper - Search tag in package org.gs1.gs1encoders
- Section
C
- Converting an AI element string to barcode message data - Search tag in package org.gs1.gs1encoders
- Section
D
- DataBarExpanded - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1 DataBar Expanded (Stacked)
- DataBarLimited - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1 DataBar Limited
- DataBarOmni - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1 DataBar Omnidirectional
- DataBarStacked - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1 DataBar Stacked
- DataBarStackedOmni - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1 DataBar Stacked Omnidirectional
- DataBarTruncated - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1 DataBar Truncated
- DigSigSerialKey - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Serialisation qualifier AIs must be present with Digital Signature (locked: always enabled)
- DM - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
(GS1) Data Matrix
- DotCode - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
(GS1) DotCode
E
- EAN13 - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
EAN-13
- EAN8 - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
EAN-8
- Example uses - Search tag in package org.gs1.gs1encoders
- Section
G
- getAddCheckDigit() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the current status of the "add check digit" mode for EAN/UPC and GS1 DataBar symbols.
- getAIdataStr() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the barcode data input buffer in human-friendly GS1 AI syntax.
- getDataStr() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the raw data that would be directly encoded within a GS1 barcode message.
- getDLignoredQueryParams() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the non-numeric (ignored) query parameters from a GS1 Digital Link URI.
- getDLuri(String) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get a GS1 Digital Link URI that represents the AI-based input data.
- getErrMarkup() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the error markup generated when parsing AI data fails due to a linting failure.
- getHRI() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the Human-Readable Interpretation ("HRI") text for the current data input buffer.
- getIncludeDataTitlesInHRI() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the status of the "include data titles in HRI" flag.
- getPermitUnknownAIs() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the status of the "permit unknown AIs" mode.
- getPermitZeroSuppressedGTINinDLuris() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the status of the "permit zero-suppressed GTINs in GS1 DL URIs" mode.
- getScanData() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the expected scan data string that a reader should return.
- getSym() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the current symbology type.
- getValidateAIassociations() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Deprecated.
- getValidationEnabled(GS1Encoder.Validation) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the current enabled status of the provided AI validation procedure.
- getVersion() - Method in class org.gs1.gs1encoders.GS1Encoder
-
Get the version string of the library.
- GS1_128_CCA - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1-128 with CC-A or CC-B
- GS1_128_CCC - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
GS1-128 with CC
- GS1 AI data validation and extraction (including GS1 Digital Link) - Search tag in package org.gs1.gs1encoders
- Section
- GS1 Barcode Syntax Engine - Java wrapper. - Search tag in package org.gs1.gs1encoders
- Section
- GS1Encoder - Class in org.gs1.gs1encoders
-
Main class for processing GS1 barcode data, including validation, format conversion, and generation of outputs such as GS1 Digital Link URIs and Human-Readable Interpretation text.
- GS1Encoder() - Constructor for class org.gs1.gs1encoders.GS1Encoder
-
Initialises a new instance of the GS1Encoder class.
- GS1Encoder.Symbology - Enum Class in org.gs1.gs1encoders
-
Recognised GS1 barcode formats ("symbologies") for processing scan data.
- GS1Encoder.Validation - Enum Class in org.gs1.gs1encoders
-
Optional AI validation procedures that may be applied to detect invalid inputs.
- GS1EncoderDigitalLinkException - Exception Class in org.gs1.gs1encoders
-
Custom error class for the wrapper for accessing the GS1 Barcode Syntax Engine native library from Java.
- GS1EncoderDigitalLinkException(String) - Constructor for exception class org.gs1.gs1encoders.GS1EncoderDigitalLinkException
-
Constructs a new GS1EncoderDigitalLinkException with the specified error message.
- GS1EncoderGeneralException - Exception Class in org.gs1.gs1encoders
-
Custom error class for the wrapper for accessing the GS1 Barcode Syntax Engine native library from Java.
- GS1EncoderGeneralException(String) - Constructor for exception class org.gs1.gs1encoders.GS1EncoderGeneralException
-
Constructs a new GS1EncoderGeneralException with the specified error message.
- GS1EncoderParameterException - Exception Class in org.gs1.gs1encoders
-
Custom error class for the wrapper for accessing the GS1 Barcode Syntax Engine native library from Java.
- GS1EncoderParameterException(String) - Constructor for exception class org.gs1.gs1encoders.GS1EncoderParameterException
-
Constructs a new GS1EncoderParameterException with the specified error message.
- GS1EncoderScanDataException - Exception Class in org.gs1.gs1encoders
-
Custom error class for the wrapper for accessing the GS1 Barcode Syntax Engine native library from Java.
- GS1EncoderScanDataException(String) - Constructor for exception class org.gs1.gs1encoders.GS1EncoderScanDataException
-
Constructs a new GS1EncoderScanDataException with the specified error message.
M
- MutexAIs - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Mutually exclusive AIs (locked: always enabled)
N
- NONE - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
None defined
- NUMSYMS - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
Value is the number of symbologies
- NUMVALIDATIONS - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Value is the number of validations
O
- org.gs1.gs1encoders - package org.gs1.gs1encoders
-
GS1 Barcode Syntax Engine - Java wrapper.
Q
- QR - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
(GS1) QR Code
- Quick start - Search tag in package org.gs1.gs1encoders
- Section
R
- RepeatedAIs - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Repeated AIs having same value (locked: always enabled)
- RequisiteAIs - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Mandatory associations between AIs
- Running the example application - Search tag in package org.gs1.gs1encoders
- Section
S
- setAddCheckDigit(boolean) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Enable or disable "add check digit" mode for EAN/UPC and GS1 DataBar symbols.
- setAIdataStr(String) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Set the barcode data input buffer using GS1 Application Identifier syntax.
- setDataStr(String) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Set the raw data that would be directly encoded within a GS1 barcode message.
- setIncludeDataTitlesInHRI(boolean) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Set the "include data titles in HRI" flag.
- setPermitUnknownAIs(boolean) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Set the "permit unknown AIs" mode.
- setPermitZeroSuppressedGTINinDLuris(boolean) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Set the status of the "permit zero-suppressed GTINs in GS1 DL URIs" mode.
- setScanData(String) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Process scan data received from a barcode reader.
- setSym(GS1Encoder.Symbology) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Set the symbology type.
- setValidateAIassociations(boolean) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Deprecated.
- setValidationEnabled(GS1Encoder.Validation, boolean) - Method in class org.gs1.gs1encoders.GS1Encoder
-
Enable or disable the given AI validation procedure.
U
- UnknownAInotDLattr - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Unknown AIs not permitted as GS1 DL URI data attributes
- UPCA - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
UPC-A
- UPCE - Enum constant in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
UPC-E
- Using in Your Own Project - Search tag in package org.gs1.gs1encoders
- Section
V
- valueOf(String) - Static method in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.gs1.gs1encoders.GS1Encoder.Symbology
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.gs1.gs1encoders.GS1Encoder.Validation
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Serialized Form
GS1Encoder.getValidationEnabled(Validation)instead