net.glxn.qrgen.core

Class AbstractQRCode

java.lang.Object

net.glxn.qrgen.core.AbstractQRCode

public abstract class AbstractQRCode
extends Object

QRCode generator. This is a simple class that is built on top of ZXING

Please take a look at their framework, as it has a lot of features.
This small project is just a wrapper that gives a convenient interface to work with.

Start here: AbstractQRCode#from(String) (e.g QRCode.from("hello"))

Field Summary

Fields

Modifier and Type	Field and Description
protected int	height
protected HashMap<com.google.zxing.EncodeHintType,Object>	hints
protected ImageType	imageType
protected com.google.zxing.Writer	qrWriter
protected int	width

Constructor Summary

Constructors

Constructor and Description
AbstractQRCode()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.google.zxing.common.BitMatrix	createMatrix(String text)
protected File	createTempFile()
protected File	createTempFile(String name)
abstract File	file() returns a File representation of the QR code.
abstract File	file(String name) returns a File representation of the QR code.
com.google.zxing.Writer	getQrWriter()
void	setQrWriter(com.google.zxing.Writer qrWriter)
ByteArrayOutputStream	stream() returns a ByteArrayOutputStream representation of the QR code
AbstractQRCode	to(ImageType imageType) Overrides the imageType from its default ImageType.PNG
AbstractQRCode	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)
AbstractQRCode	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)
AbstractQRCode	withHint(com.google.zxing.EncodeHintType hintType, Object value) Sets hint to QRCodeWriter.encode(java.lang.String, com.google.zxing.BarcodeFormat, int, int)
AbstractQRCode	withSize(int width, int height) Overrides the size of the qr from its default 125x125
void	writeTo(OutputStream stream) writes a representation of the QR code to the supplied OutputStream
protected abstract void	writeToStream(OutputStream stream)

Methods inherited from class java.lang.Object

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

Field Detail

hints

protected final HashMap<com.google.zxing.EncodeHintType,Object> hints

qrWriter

protected com.google.zxing.Writer qrWriter

width

protected int width

height

protected int height

imageType

protected ImageType imageType

Constructor Detail

AbstractQRCode

public AbstractQRCode()

Method Detail

to

public AbstractQRCode 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 AbstractQRCode 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 AbstractQRCode 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)

Returns:

the current QRCode object

withErrorCorrection

public AbstractQRCode 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)

Returns:

the current QRCode object

withHint

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

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

Returns:

the current QRCode object

file

public abstract File file()

returns a File representation of the QR code. The file is set to be deleted on exit (i.e. File.deleteOnExit()). If you want the file to live beyond the life of the jvm process, you should make a copy.

Returns:

qrcode as file

file

public abstract File file(String name)

returns a File representation of the QR code. The file has the given name. The file is set to be deleted on exit (i.e. File.deleteOnExit()). If you want the file to live beyond the life of the jvm process, you should make a copy.

Parameters:

name - name of the created file

Returns:

qrcode as file

See Also:

file()

stream

public ByteArrayOutputStream stream()

returns a ByteArrayOutputStream representation of the QR code

Returns:

qrcode as stream

writeTo

public void writeTo(OutputStream stream)

writes a representation of the QR code to the supplied OutputStream

Parameters:

stream - the OutputStream to write QR Code to

writeToStream

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

Throws:

IOException

com.google.zxing.WriterException

createMatrix

protected com.google.zxing.common.BitMatrix createMatrix(String text)
                                                  throws com.google.zxing.WriterException

Throws:

com.google.zxing.WriterException

createTempFile

protected File createTempFile()
                       throws IOException

Throws:

IOException

createTempFile

protected File createTempFile(String name)
                       throws IOException

Throws:

IOException

getQrWriter

public com.google.zxing.Writer getQrWriter()

setQrWriter

public void setQrWriter(com.google.zxing.Writer qrWriter)