Package net.webpdf.wsclient.openapi

Class OperationPdf417Barcode

  • public class OperationPdf417Barcode
extends Object
    A PDF417 barcode.

    • Constructor Detail

      • OperationPdf417Barcode

        public OperationPdf417Barcode()

    • Method Detail

      • getCharset

        @Nullable
public @Nullable String getCharset()
        Used to specify the character set in which the barcode contents should be stored.
        Returns:
        charset

      • setCharset

        public void setCharset​(String charset)

      • getCompact

        @Nullable
public @Nullable Boolean getCompact()
        If this value is set to \"true,\" the contents of all generated PDF417 barcodes will be compressed using the encoding selected with the \"compactionMode\" attribute.
        Returns:
        compact

      • setCompact

        public void setCompact​(Boolean compact)

      • getCompactionMode

        @Nullable
public @Nullable OperationPdf417Barcode.CompactionModeEnum getCompactionMode()
        If PDF417 barcode compression has been enabled with the \"compact\" attribute, the encoding selected here for the compression of generated PDF417 barcodes will be used. * auto = Try to determine the best encoding method automatically. * byte = Select a byte encoding method in which every 5 codewords represent 6 bytes. * numeric = Select a numeric encoding method in which a group of 15 codewords represents up to 44 decimal numbers. * text = Select a text encoding method in which each codeword represents up to 2 letters.
        Returns:
        compactionMode

      • getDataCodewordsMax

        @Nullable
public @Nullable Integer getDataCodewordsMax()
        Used to specify the maximum number of codewords allowed in a single PDF417 barcode row. minimum: 1
        Returns:
        dataCodewordsMax

      • setDataCodewordsMax

        public void setDataCodewordsMax​(Integer dataCodewordsMax)

      • getDataCodewordsMin

        @Nullable
public @Nullable Integer getDataCodewordsMin()
        Used to specify the minimum number of codewords allowed in a single PDF417 barcode row. minimum: 1
        Returns:
        dataCodewordsMin

      • setDataCodewordsMin

        public void setDataCodewordsMin​(Integer dataCodewordsMin)

      • getErrorCorrection

        @Nullable
public @Nullable Integer getErrorCorrection()
        Used to adjust the error correction level for generated PDF417 codes. The higher the level, the more error-resistant the barcode, ensuring that damaged codes will still be readable. A level of 1 to 8 can be specified. minimum: 1 maximum: 8
        Returns:
        errorCorrection

      • setErrorCorrection

        public void setErrorCorrection​(Integer errorCorrection)

      • getMargin

        @Nullable
public @Nullable Integer getMargin()
        Used to specify the width of the empty frame that should be generated around the barcode. This shall use the same metrics as the position - if no position is present, the default (mm) shall be assumed. minimum: 0
        Returns:
        margin

      • setMargin

        public void setMargin​(Integer margin)

      • getPages

        @Nullable
public @Nullable String getPages()
        The page range for generating barcodes. Individual pages or a range of pages can be defined here. If the text is empty, the entire file will be exported (e.g.: \"1-10\" or \"1,2,5-10\")
        Returns:
        pages

      • setPages

        public void setPages​(String pages)

      • getPosition

        @Nullable
public @Nullable OperationRectangle getPosition()
        Get position
        Returns:
        position

      • getRotation

        @Nullable
public @Nullable Integer getRotation()
        Used to specify the barcode's rotation in 90-degree increments. When there is a value that falls under a full 90-degree increment, the next higher increment will be automatically selected. minimum: 0
        Returns:
        rotation

      • setRotation

        public void setRotation​(Integer rotation)

      • getShape

        @Nullable
public @Nullable OperationPdf417Barcode.ShapeEnum getShape()
        Can be used to force a specific shape for generated Data Matrix codes. * default = Select an appropriate shape. * rectangle = Force a rectangular shape. * square = Force a square shape.
        Returns:
        shape

      • getSymbolsPerCodewordMax

        @Nullable
public @Nullable Integer getSymbolsPerCodewordMax()
        Used to specify the maximum number of code symbols that are allowed to be in a single codeword in the PDF417 barcode. minimum: 1
        Returns:
        symbolsPerCodewordMax

      • setSymbolsPerCodewordMax

        public void setSymbolsPerCodewordMax​(Integer symbolsPerCodewordMax)

      • getSymbolsPerCodewordMin

        @Nullable
public @Nullable Integer getSymbolsPerCodewordMin()
        Used to specify the minimum number of code symbols that are allowed to be in a single codeword in the PDF417 barcode. minimum: 1
        Returns:
        symbolsPerCodewordMin

      • setSymbolsPerCodewordMin

        public void setSymbolsPerCodewordMin​(Integer symbolsPerCodewordMin)

      • getValue

        @NotNull
public @NotNull String getValue()
        Contains the value that should be encoded in the barcode. Depending on the selected barcode format, there may be specific criteria for the data structure. For a description, please refer to the chapter \"Barcodes\"
        Returns:
        value

      • setValue

        public void setValue​(String value)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object