de.ipcon.tools

Class BarCode

java.lang.Object

de.ipcon.tools.BarCode

public class BarCode
extends java.lang.Object

A convenient wrapper for both the iText barcode API and the ZXing library, designed to simplify barcode generation.

The iText barcode API and ZXing library can be cumbersome to use directly. This wrapper provides a more user-friendly interface, especially tailored for generating barcodes and QR codes in reports where most of the complexity of these APIs is unnecessary.

This class aims to streamline the creation and customization of barcodes and QR codes, providing sensible defaults and easy access to commonly used features of both the iText and ZXing APIs.

See Also:

com.itextpdf.text.pdf.Barcode, com.itextpdf.text.pdf.BarcodeEAN, com.google.zxing

Method Summary

Modifier and Type	Method and Description
static java.awt.Image	code128(java.lang.String code128) Takes a String and returns an Image showing the correct CODE128 barcode.
static java.awt.Image	code128(java.lang.String code128, boolean ignoreErrors)
static java.awt.Image	ean13(java.lang.String eanCode) Takes a String and returns an Image showing the correct EAN13 barcode.
static java.awt.Image	ean13(java.lang.String eanCode, boolean ignoreErrors)
static java.awt.Image	error(java.lang.String msgL10nKey, java.lang.String wrongEANCode, boolean ignoreErrors) Signals an IllegalArgumentException with the passed message or returns null if ignoreErrors is true.
static java.awt.Image	getEAN13Image(java.lang.Long id) Takes a Long, converts it to a String, prepends it with zeros to get a length of 12 chars and returns an Image showing the correct EAN13 code.
static java.awt.Image	getEAN13Image(java.lang.String eanCode) Takes a String with a length of 12 chars (or 12 chars plus checksum char) and returns an Image showing the correct EAN13 code.
static java.awt.Image	getEAN13Image(java.lang.String eanCode, boolean ignoreErrors)
static java.awt.Image	getEAN8Image(java.lang.String eanCode) Takes a String with a length of 7 chars (or 7 chars plus checksum char) and returns an Image showing the correct EAN8 code.
static java.awt.Image	getEAN8Image(java.lang.String eanCode, boolean ignoreErrors)
static java.awt.Image	getEANImage(int codeType, java.lang.String eanCode) Takes a code type and a String and returns an Image showing the correct EAN-code for the passed codetype, using the passed foreground and background colors, only containing the bars without any text.
static java.awt.Image	getEANImage(int codeType, java.lang.String eanCode, java.awt.Color foreground)
static java.awt.Image	getEANImage(int codeType, java.lang.String eanCode, java.awt.Color foreground, java.awt.Color background)
static java.awt.Image	getQRCodeImage(java.lang.String qrCode) Takes a String and a size and returns an Image showing the correct QR code in the given size.
static java.awt.Image	getQRCodeImage(java.lang.String qrCode, int size)
static java.awt.Image	getQRCodeImage(java.lang.String qrCode, int size, boolean ignoreErrors)

Methods inherited from class java.lang.Object

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

Method Detail

getEAN13Image

public static java.awt.Image getEAN13Image(java.lang.Long id)

Takes a Long, converts it to a String, prepends it with zeros to get a length of 12 chars and returns an Image showing the correct EAN13 code.

Parameters:

id - a Long that shall be rendered as EAN13 barcode

Returns:

an image showing the EAN13 code for the passed Long, possibly prepended with zeros to reach length of 12 digits

getEAN13Image

public static java.awt.Image getEAN13Image(java.lang.String eanCode)

Takes a String with a length of 12 chars (or 12 chars plus checksum char) and returns an Image showing the correct EAN13 code.

Parameters:

eanCode - a String of length 12 or 13 chars (with checksum) that shall be rendered as EAN13 barcode

ignoreErrors - whether errors should be ignored or not, defaults to true

Returns:

an image showing the EAN13 code for the passed String or null in case of an error if ignoreErrors is true

Throws:

java.lang.IllegalArgumentException - in case of an error if ignoreErrors is false

getEAN13Image

public static java.awt.Image getEAN13Image(java.lang.String eanCode,
                                           boolean ignoreErrors)

getEAN8Image

public static java.awt.Image getEAN8Image(java.lang.String eanCode)

Takes a String with a length of 7 chars (or 7 chars plus checksum char) and returns an Image showing the correct EAN8 code.

Parameters:

eanCode - a String of length 7 or 8 chars (with checksum) that shall be rendered as EAN8 barcode

ignoreErrors - whether errors should be ignored or not, defaults to true

Returns:

an image showing the EAN8 code for the passed String or null in case of an error if ignoreErrors is true

Throws:

java.lang.IllegalArgumentException - in case of an error if ignoreErrors is false

getEAN8Image

public static java.awt.Image getEAN8Image(java.lang.String eanCode,
                                          boolean ignoreErrors)

error

public static java.awt.Image error(java.lang.String msgL10nKey,
                                   java.lang.String wrongEANCode,
                                   boolean ignoreErrors)

Signals an IllegalArgumentException with the passed message or returns null if ignoreErrors is true.

Parameters:

msgL10nKey - a String with the L10n key for rendering a message to log and to use in a possibly signalled IllegalArgumentException

wrongEANCode - the erroneous EAN code that triggered the error

ignoreErrors - if true, null is returned, otherwise an IllegalArgumentException is signalled

Returns:

null in case ignoreErrors is true, signals an IllegalArgumentException using the passed L10n message key otherwise

Throws:

java.lang.IllegalArgumentException - if ignoreErrors is false

getEANImage

public static java.awt.Image getEANImage(int codeType,
                                         java.lang.String eanCode)

Takes a code type and a String and returns an Image showing the correct EAN-code for the passed codetype, using the passed foreground and background colors, only containing the bars without any text. Codetype can be any valid type of Barcode for com.lowagie.text.pdf.Barcode#setCodeType(int), i.e. EAN8/EAN13/UPCE/UPCA/SUPP2/SUPP5/CODABAR/CODE128/CODE128_RAW/CODE128_UCC/PLANET/POSTNET

Parameters:

codeType - an int representing a type of barcode, see com.lowagie.text.pdf.Barcode#setCodeType(int) for valid types

eanCode - a String of the correct length for the selected type of barcode that shall be rendered

foreground - the foreground color to use for the barcode, defaults to Color.BLACK

background - the background color to use for the barcode, defaults to Color.WHITE

Returns:

an image showing the EAN8 code for the passed String

getEANImage

public static java.awt.Image getEANImage(int codeType,
                                         java.lang.String eanCode,
                                         java.awt.Color foreground)

getEANImage

public static java.awt.Image getEANImage(int codeType,
                                         java.lang.String eanCode,
                                         java.awt.Color foreground,
                                         java.awt.Color background)

getQRCodeImage

public static java.awt.Image getQRCodeImage(java.lang.String qrCode)

Takes a String and a size and returns an Image showing the correct QR code in the given size.

Parameters:

qrCode - a String that shall be rendered as QR code

size - (will be ignored and kept only for compatibility). The size will be data-dependent.

ignoreErrors - whether errors should be ignored or not, defaults to true

Returns:

an image showing the QR code for the passed String or null in case of an error if ignoreErrors is true

Throws:

IRuntimeException - in case of an error if ignoreErrors is false

getQRCodeImage

public static java.awt.Image getQRCodeImage(java.lang.String qrCode,
                                            int size)

getQRCodeImage

public static java.awt.Image getQRCodeImage(java.lang.String qrCode,
                                            int size,
                                            boolean ignoreErrors)

ean13

public static java.awt.Image ean13(java.lang.String eanCode)

Takes a String and returns an Image showing the correct EAN13 barcode.

Parameters:

eanCode - a String that shall be rendered as EAN13 barcode

ignoreErrors - whether errors should be ignored or not, defaults to true

Returns:

an image showing the EAN13 barcode for the passed String or null in case of an error if ignoreErrors is true

Throws:

java.lang.RuntimeException - in case of an error if ignoreErrors is false

ean13

public static java.awt.Image ean13(java.lang.String eanCode,
                                   boolean ignoreErrors)

code128

public static java.awt.Image code128(java.lang.String code128)

Takes a String and returns an Image showing the correct CODE128 barcode.

Parameters:

code128 - a String that shall be rendered as CODE128 barcode

ignoreErrors - whether errors should be ignored or not, defaults to true

Returns:

an image showing the CODE128 barcode for the passed String or null in case of an error if ignoreErrors is true

Throws:

java.lang.RuntimeException - in case of an error if ignoreErrors is false

code128

public static java.awt.Image code128(java.lang.String code128,
                                     boolean ignoreErrors)