Package com.google.zxing

Enum EncodeHintType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EncodeHintType>
    public enum EncodeHintType
extends java.lang.Enum<EncodeHintType>
    These are a set of hints that you may pass to Writers to specify their behavior.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AZTEC_LAYERS
      Specifies the required number of layers for an Aztec code: a negative number (-1, -2, -3, -4) specifies a compact Aztec code 0 indicates to use the minimum number of layers (the default) a positive number (1, 2, ..
      CHARACTER_SET
      Specifies what character encoding to use where applicable (type String)
      DATA_MATRIX_SHAPE
      Specifies the matrix shape for Data Matrix (type SymbolShapeHint)
      ERROR_CORRECTION
      Specifies what degree of error correction to use, for example in QR Codes.
      MARGIN
      Specifies margin, in pixels, to use when generating the barcode.
      MAX_SIZE
      Specifies a maximum barcode size (type Dimension).
      MIN_SIZE
      Specifies a minimum barcode size (type Dimension).
      PDF417_COMPACT
      Specifies whether to use compact mode for PDF417 (type Boolean).
      PDF417_COMPACTION
      Specifies what compaction mode to use for PDF417 (type Compaction).
      PDF417_DIMENSIONS
      Specifies the minimum and maximum number of rows and columns for PDF417 (type Dimensions).

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static EncodeHintType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EncodeHintType[] 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

      • ERROR_CORRECTION

        public static final EncodeHintType ERROR_CORRECTION
        Specifies what degree of error correction to use, for example in QR Codes. Type depends on the encoder. For example for QR codes it's type ErrorCorrectionLevel. For Aztec it is of type Integer, representing the minimal percentage of error correction words. Note: an Aztec symbol should have a minimum of 25% EC words.

      • CHARACTER_SET

        public static final EncodeHintType CHARACTER_SET
        Specifies what character encoding to use where applicable (type String)

      • MIN_SIZE

        public static final EncodeHintType MIN_SIZE
        Specifies a minimum barcode size (type Dimension). Only applicable to Data Matrix now.

      • MAX_SIZE

        public static final EncodeHintType MAX_SIZE
        Specifies a maximum barcode size (type Dimension). Only applicable to Data Matrix now.

      • MARGIN

        public static final EncodeHintType MARGIN
        Specifies margin, in pixels, to use when generating the barcode. The meaning can vary by format; for example it controls margin before and after the barcode horizontally for most 1D formats. (Type Integer).

      • PDF417_COMPACT

        public static final EncodeHintType PDF417_COMPACT
        Specifies whether to use compact mode for PDF417 (type Boolean).

      • PDF417_COMPACTION

        public static final EncodeHintType PDF417_COMPACTION
        Specifies what compaction mode to use for PDF417 (type Compaction).

      • PDF417_DIMENSIONS

        public static final EncodeHintType PDF417_DIMENSIONS
        Specifies the minimum and maximum number of rows and columns for PDF417 (type Dimensions).

      • AZTEC_LAYERS

        public static final EncodeHintType AZTEC_LAYERS
        Specifies the required number of layers for an Aztec code: a negative number (-1, -2, -3, -4) specifies a compact Aztec code 0 indicates to use the minimum number of layers (the default) a positive number (1, 2, .. 32) specifies a normaol (non-compact) Aztec code

    • Method Detail

      • values

        public static EncodeHintType[] 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 (EncodeHintType c : EncodeHintType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EncodeHintType 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