com.google.zxing
Enum ResultMetadataType

java.lang.Object
  extended by java.lang.Enum<ResultMetadataType>
      extended by com.google.zxing.ResultMetadataType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ResultMetadataType>

public enum ResultMetadataType
extends java.lang.Enum<ResultMetadataType>

Represents some type of metadata about the result of the decoding that the decoder wishes to communicate back to the caller.

Author:
Sean Owen

Enum Constant Summary
BYTE_SEGMENTS
          2D barcode formats typically encode text, but allow for a sort of 'byte mode' which is sometimes used to encode binary data.
ERROR_CORRECTION_LEVEL
          Error correction level used, if applicable.
ISSUE_NUMBER
          For some periodicals, indicates the issue number as an Integer.
ORIENTATION
          Denotes the likely approximate orientation of the barcode in the image.
OTHER
          Unspecified, application-specific metadata.
POSSIBLE_COUNTRY
          For some products, the possible country of manufacture as a String denoting the ISO country code.
SUGGESTED_PRICE
          For some products, indicates the suggested retail price in the barcode as a formatted String.
 
Method Summary
static ResultMetadataType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ResultMetadataType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

OTHER

public static final ResultMetadataType OTHER
Unspecified, application-specific metadata. Maps to an unspecified Object.


ORIENTATION

public static final ResultMetadataType 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 an Integer whose value is in the range [0,360).


BYTE_SEGMENTS

public static final ResultMetadataType 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

public static final ResultMetadataType ERROR_CORRECTION_LEVEL
Error correction level used, if applicable. The value type depends on the format, but is typically a String.


ISSUE_NUMBER

public static final ResultMetadataType ISSUE_NUMBER
For some periodicals, indicates the issue number as an Integer.


SUGGESTED_PRICE

public static final ResultMetadataType SUGGESTED_PRICE
For some products, indicates the suggested retail price in the barcode as a formatted String.


POSSIBLE_COUNTRY

public static final ResultMetadataType POSSIBLE_COUNTRY
For some products, the possible country of manufacture as a String denoting the ISO country code. Some map to multiple possible countries, like "US/CA".

Method Detail

values

public static ResultMetadataType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ResultMetadataType c : ResultMetadataType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResultMetadataType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null