Package com.google.zxing
Enum Class ResultMetadataType
- All Implemented Interfaces:
Serializable
,Comparable<ResultMetadataType>
,Constable
Represents some type of metadata about the result of the decoding that the decoder
wishes to communicate back to the caller.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescription2D barcode formats typically encode text, but allow for a sort of 'byte mode' which is sometimes used to encode binary data.The number of erasures corrected.Error correction level used, if applicable.The number of errors corrected.For some periodicals, indicates the issue number as anInteger
.Denotes the likely approximate orientation of the barcode in the image.Unspecified, application-specific metadata.PDF417-specific metadata.For some products, the possible country of manufacture as aString
denoting the ISO country code.If the code format supports structured append and the current scanned code is part of one then the parity is given with it.If the code format supports structured append and the current scanned code is part of one then the sequence number is given with it.For some products, indicates the suggested retail price in the barcode as a formattedString
.Barcode Symbology Identifier.For some products, the extension text. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ResultMetadataType
Returns the enum constant of this class with the specified name.static ResultMetadataType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
OTHER
Unspecified, application-specific metadata. Maps to an unspecifiedObject
. -
ORIENTATION
Denotes the likely approximate orientation of the barcode in the image. This value is given as degrees rotated clockwise from the normal, upright orientation. For example a 1D barcode which was found by reading top-to-bottom would be said to have orientation "90". This key maps to anInteger
whose value is in the range [0,360). -
BYTE_SEGMENTS
2D barcode formats typically encode text, but allow for a sort of 'byte mode' which is sometimes used to encode binary data. While
Result
makes available the complete raw bytes in the barcode for these formats, it does not offer the bytes from the byte segments alone.This maps to a
List
of byte arrays corresponding to the raw bytes in the byte segments in the barcode, in order. -
ERROR_CORRECTION_LEVEL
Error correction level used, if applicable. The value type depends on the format, but is typically a String. -
ERRORS_CORRECTED
The number of errors corrected. If applicable, maps to anInteger
of value greater than or equal to zero. -
ERASURES_CORRECTED
The number of erasures corrected. If applicable, maps to anInteger
of value greater than or equal to zero. -
ISSUE_NUMBER
For some periodicals, indicates the issue number as anInteger
. -
SUGGESTED_PRICE
For some products, indicates the suggested retail price in the barcode as a formattedString
. -
POSSIBLE_COUNTRY
For some products, the possible country of manufacture as aString
denoting the ISO country code. Some map to multiple possible countries, like "US/CA". -
UPC_EAN_EXTENSION
For some products, the extension text. -
PDF417_EXTRA_METADATA
PDF417-specific metadata. -
STRUCTURED_APPEND_SEQUENCE
If the code format supports structured append and the current scanned code is part of one then the sequence number is given with it. -
STRUCTURED_APPEND_PARITY
If the code format supports structured append and the current scanned code is part of one then the parity is given with it. -
SYMBOLOGY_IDENTIFIER
Barcode Symbology Identifier. Note: According to the GS1 specification the identifier may have to replace a leading FNC1/GS character when prepending to the barcode content.
-
-
Constructor Details
-
ResultMetadataType
private ResultMetadataType()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-