io.nayuki.qrcodegen

Class QrSegmentAdvanced

java.lang.Object

io.nayuki.qrcodegen.QrSegmentAdvanced

public final class QrSegmentAdvanced
extends Object

Constructor Summary

Constructors

Constructor and Description
QrSegmentAdvanced()

Method Summary

Modifier and Type	Method and Description
static boolean	isEncodableAsKanji(String text) Tests whether the specified text string can be encoded as a segment in kanji mode.
static QrSegment	makeKanjiSegment(String text) Returns a segment representing the specified string encoded in kanji mode.
static List<QrSegment>	makeSegmentsOptimally(String text, QrCode.Ecc ecl, int minVersion, int maxVersion) Returns a new mutable list of zero or more segments to represent the specified Unicode text string.

Methods inherited from class java.lang.Object

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

Constructor Detail

QrSegmentAdvanced

public QrSegmentAdvanced()

Method Detail

makeSegmentsOptimally

public static List<QrSegment> makeSegmentsOptimally(String text,
                                                    QrCode.Ecc ecl,
                                                    int minVersion,
                                                    int maxVersion)

Returns a new mutable list of zero or more segments to represent the specified Unicode text string. The resulting list optimally minimizes the total encoded bit length, subjected to the constraints given by the specified {error correction level, minimum version number, maximum version number}, plus the additional constraint that the segment modes {NUMERIC, ALPHANUMERIC, BYTE} can be used but KANJI cannot be used.

This function can be viewed as a significantly more sophisticated and slower replacement for QrSegment.makeSegments(String), but requiring more input parameters in a way that overlaps with QrCode.encodeSegments(List,QrCode.Ecc,int,int,int,boolean).

Parameters:

text - the text to be encoded, which can be any Unicode string

ecl - the error correction level to use

minVersion - the minimum allowed version of the QR symbol (at least 1)

maxVersion - the maximum allowed version of the QR symbol (at most 40)

Returns:

a list of segments containing the text, minimizing the bit length with respect to the constraints

Throws:

NullPointerException - if the data or error correction level is null

IllegalArgumentException - if 1 ≤ minVersion ≤ maxVersion ≤ 40 is violated, or if the data is too long to fit in a QR Code at maxVersion at the ECL

makeKanjiSegment

public static QrSegment makeKanjiSegment(String text)

Returns a segment representing the specified string encoded in kanji mode.

Note that broadly speaking, the set of encodable characters are {kanji used in Japan, hiragana, katakana, Asian punctuation, full-width ASCII}.
In particular, non-encodable characters are {normal ASCII, half-width katakana, more extensive Chinese hanzi}.

Parameters:

text - the text to be encoded, which must fall in the kanji mode subset of characters

Returns:

a segment containing the data

Throws:

NullPointerException - if the string is null

IllegalArgumentException - if the string contains non-kanji-mode characters

See Also:

isEncodableAsKanji(String)

isEncodableAsKanji

public static boolean isEncodableAsKanji(String text)

Tests whether the specified text string can be encoded as a segment in kanji mode.

Note that broadly speaking, the set of encodable characters are {kanji used in Japan, hiragana, katakana, Asian punctuation, full-width ASCII}.
In particular, non-encodable characters are {normal ASCII, half-width katakana, more extensive Chinese hanzi}.

Parameters:

text - the string to test for encodability

Returns:

true if and only if the string can be encoded in kanji mode

Throws:

NullPointerException - if the string is null

See Also:

makeKanjiSegment(String)