com.itextpdf.text.pdf.qrcode

Class Encoder

java.lang.Object

com.itextpdf.text.pdf.qrcode.Encoder

public final class Encoder
extends Object

Since:

5.0.2

Author:

satorux@google.com (Satoru Takabayashi) - creator, dswitkin@google.com (Daniel Switkin) - ported from C++

Method Summary

Modifier and Type	Method and Description
static Mode	chooseMode(String content)
static Mode	chooseMode(String content, String encoding) Choose the best mode by examining the content.
static void	encode(String content, ErrorCorrectionLevel ecLevel, Map<EncodeHintType,Object> hints, QRCode qrCode)
static void	encode(String content, ErrorCorrectionLevel ecLevel, QRCode qrCode) Encode "bytes" with the error correction level "ecLevel".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encode

public static void encode(String content,
                          ErrorCorrectionLevel ecLevel,
                          QRCode qrCode)
                   throws WriterException

Encode "bytes" with the error correction level "ecLevel". The encoding mode will be chosen internally by chooseMode(). On success, store the result in "qrCode". We recommend you to use QRCode.EC_LEVEL_L (the lowest level) for "getECLevel" since our primary use is to show QR code on desktop screens. We don't need very strong error correction for this purpose. Note that there is no way to encode bytes in MODE_KANJI. We might want to add EncodeWithMode() with which clients can specify the encoding mode. For now, we don't need the functionality.

Throws:

WriterException

encode

public static void encode(String content,
                          ErrorCorrectionLevel ecLevel,
                          Map<EncodeHintType,Object> hints,
                          QRCode qrCode)
                   throws WriterException

Throws:

WriterException

chooseMode

public static Mode chooseMode(String content)

chooseMode

public static Mode chooseMode(String content,
                              String encoding)

Choose the best mode by examining the content. Note that 'encoding' is used as a hint; if it is Shift_JIS, and the input is only double-byte Kanji, then we return Mode.KANJI.