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
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(String text) Create a QR code from the given text.
static AbstractQRCode	from(VCard vcard) Creates a a QR Code from the given VCard.
protected void	writeToStream(OutputStream stream)

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

createMatrix, createTempFile, createTempFile, getQrWriter, setQrWriter, stream, to, withCharset, withErrorCorrection, withHint, withSize, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

text

protected final String text

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 AbstractQRCode.to(net.glxn.qrgen.core.image.ImageType) e.g. QRCode.from("hello world").to(JPG)
Size override is done by calling AbstractQRCode.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 AbstractQRCode from(VCard vcard)

Creates a a QR Code from the given VCard.

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

Parameters:

vcard - the vcard to encode as QRCode

Returns:

the 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