net.glxn.qrgen.javase

Class QRCode

java.lang.Object

net.glxn.qrgen.core.AbstractQRCode

net.glxn.qrgen.javase.QRCode

public class QRCode
extends AbstractQRCode

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.zxing.client.j2se.MatrixToImageConfig	DEFAULT_CONFIG
protected com.google.zxing.client.j2se.MatrixToImageConfig	matrixToImageConfig
protected String	text

Fields inherited from class net.glxn.qrgen.core.AbstractQRCode

height, hints, imageType, qrWriter, width

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QRCode(String text)

Method Summary

Methods

Modifier and Type	Method and Description
File	file()
File	file(String name)
static QRCode	from(Schema schema) Creates a a QR Code from the given Schema.
static QRCode	from(String text) Create a QR code from the given text.
QRCode	to(ImageType imageType) Overrides the imageType from its default ImageType.PNG
QRCode	withCharset(String charset) Overrides the default charset by supplying a EncodeHintType.CHARACTER_SET hint to QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)
QRCode	withColor(int onColor, int offColor)
QRCode	withErrorCorrection(com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level) Overrides the default error correction by supplying a EncodeHintType.ERROR_CORRECTION hint to QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)
QRCode	withHint(com.google.zxing.EncodeHintType hintType, Object value) Sets hint to QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)
QRCode	withSize(int width, int height) Overrides the size of the qr from its default 125x125
protected void	writeToStream(OutputStream stream)

Methods inherited from class net.glxn.qrgen.core.AbstractQRCode

createMatrix, createTempFile, createTempFile, getQrWriter, setQrWriter, stream, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG

public static final com.google.zxing.client.j2se.MatrixToImageConfig DEFAULT_CONFIG

text

protected final String text

matrixToImageConfig

protected com.google.zxing.client.j2se.MatrixToImageConfig matrixToImageConfig

Constructor Detail

QRCode

protected QRCode(String text)

Method Detail

from

public static QRCode from(String text)

Create a QR code from the given text.

There is a size limitation to how much you can put into a QR code. This has been tested to work with up to a length of 2950 characters.

The QRCode will have the following defaults:
{size: 100x100}
{imageType:PNG}

Both size and imageType can be overridden:
Image type override is done by calling to(ImageType) e.g. QRCode.from("hello world").to(JPG)
Size override is done by calling withSize(int, int) e.g. QRCode.from("hello world").to(JPG).withSize(125, 125)

Parameters:

text - the text to encode to a new QRCode, this may fail if the text is too large.

Returns:

the QRCode object

from

public static QRCode from(Schema schema)

Creates a a QR Code from the given Schema.

The QRCode will have the following defaults:
{size: 100x100}
{imageType:PNG}

Parameters:

schema - the schema to encode as QRCode

Returns:

the QRCode object

to

public QRCode to(ImageType imageType)

Overrides the imageType from its default ImageType.PNG

Parameters:

imageType - the ImageType you would like the resulting QR to be

Returns:

the current QRCode object

withSize

public QRCode withSize(int width,
              int height)

Overrides the size of the qr from its default 125x125

Parameters:

width - the width in pixels

height - the height in pixels

Returns:

the current QRCode object

withCharset

public QRCode withCharset(String charset)

Overrides the default charset by supplying a EncodeHintType.CHARACTER_SET hint to QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)

Parameters:

charset - the charset as string, e.g. UTF-8

Returns:

the current QRCode object

withErrorCorrection

public QRCode withErrorCorrection(com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level)

Overrides the default error correction by supplying a EncodeHintType.ERROR_CORRECTION hint to QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)

Parameters:

level - the error correction level to use by QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)

Returns:

the current QRCode object

withHint

public QRCode withHint(com.google.zxing.EncodeHintType hintType,
              Object value)

Sets hint to QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)

Parameters:

hintType - the hintType to set

value - the concrete value to set

Returns:

the current QRCode object

file

public File file()

Specified by:

file in class AbstractQRCode

file

public File file(String name)

Specified by:

file in class AbstractQRCode

writeToStream

protected void writeToStream(OutputStream stream)
                      throws IOException,
                             com.google.zxing.WriterException

Specified by:

writeToStream in class AbstractQRCode

Throws:

IOException

com.google.zxing.WriterException

withColor

public QRCode withColor(int onColor,
               int offColor)