org.xbib.standardnumber

Class EAN

java.lang.Object

org.xbib.standardnumber.StandardNumber

org.xbib.standardnumber.EAN

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<EAN>

public class EAN
extends StandardNumber
implements java.lang.Cloneable, java.lang.Comparable<EAN>

European Article Number is a 13-digit barcoding standard for marking products sold at retail point of sale.

Numbers encoded in UPC and EAN barcodes are known as Global Trade Item Numbers (GTIN).

Field Summary

Fields inherited from class org.xbib.standardnumber.StandardNumber

type, value

Constructor Summary

Constructors

Constructor and Description
EAN()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a clone if the implementation is cloneable.
int	compareTo(EAN ean)
EAN	createChecksum(boolean createWithChecksum) Indicate that a correct check sum should be computed.
boolean	equals(java.lang.Object object)
java.lang.String	format() Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.
static StandardNumber	getInstance(java.lang.Package thePackage, java.lang.ClassLoader classLoader, java.lang.String type)
static StandardNumber	getInstance(java.lang.String type)
java.util.Collection<java.lang.String>	getTypedVariants()
int	hashCode()
boolean	isValid() Check this number for validity.
EAN	normalize() Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
java.lang.String	normalizedValue() Return normalized value of this standard number.
EAN	reset()
EAN	verify() Verify the number.

Methods inherited from class org.xbib.standardnumber.StandardNumber

set, type

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EAN

public EAN()

Method Detail

compareTo

public int compareTo(EAN ean)

Specified by:

compareTo in interface java.lang.Comparable<EAN>

createChecksum

public EAN createChecksum(boolean createWithChecksum)

Description copied from class: StandardNumber

Indicate that a correct check sum should be computed.

Specified by:

createChecksum in class StandardNumber

Parameters:

createWithChecksum - if checksum is included

Returns:

this standard number

normalize

public EAN normalize()

Description copied from class: StandardNumber

Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.

Specified by:

normalize in class StandardNumber

Returns:

this standard number

isValid

public boolean isValid()

Description copied from class: StandardNumber

Check this number for validity.

Specified by:

isValid in class StandardNumber

Returns:

true if valid, false otherwise

verify

public EAN verify()

Description copied from class: StandardNumber

Verify the number.

Specified by:

verify in class StandardNumber

Returns:

this standard number if verification was successful

normalizedValue

public java.lang.String normalizedValue()

Description copied from class: StandardNumber

Return normalized value of this standard number. In most cases, this is also the canonical form of the standard number. This is a representation without unneccessary characters, useful for computation purposes, like comparing for equivalence.

Specified by:

normalizedValue in class StandardNumber

Returns:

the normalized value

format

public java.lang.String format()

Description copied from class: StandardNumber

Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.

Specified by:

format in class StandardNumber

Returns:

a formatted value

reset

public EAN reset()

Specified by:

reset in class StandardNumber

getTypedVariants

public java.util.Collection<java.lang.String> getTypedVariants()

Specified by:

getTypedVariants in class StandardNumber

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone if the implementation is cloneable.

Returns:

a clone if the implementation is cloneable.

Throws:

java.lang.CloneNotSupportedException - if this is called on an implementation that does not support `Cloneable`

getInstance

public static StandardNumber getInstance(java.lang.String type)
                                  throws NoSuchStandardNumberException

Throws:

NoSuchStandardNumberException

getInstance

public static StandardNumber getInstance(java.lang.Package thePackage,
                                         java.lang.ClassLoader classLoader,
                                         java.lang.String type)
                                  throws NoSuchStandardNumberException

Throws:

NoSuchStandardNumberException