net.sourceforge.barbecue
Class Module

java.lang.Object
  net.sourceforge.barbecue.Module

Direct Known Subclasses:

BlankModule, CompositeModule, PDF417Module, PostNetModule, SeparatorModule

public class Module

extends java.lang.Object

Internal class that is used to organise barcode data into groups of bars.

Note: You should not instantiate this class directly.

Author:

Ian Bourke

Field Summary

protected int[]

bars The specification of bars that makes up this module, in a list of bar widths in on, off order)

Constructor Summary

Module(int[] bars)
Constructs a new Module with the given bar specification.

Method Summary

protected int	draw(Output output, int x, int y, int barWidth, int barHeight) Draws the module to the given outputter at the specified origin.
boolean	equals(java.lang.Object o) See Object.
java.lang.String	getSymbol() Returns the symbol being encoded by this module.
int	hashCode() Returns a hash code value for the object.
void	setSymbol(java.lang.String symbol) Sets the symbol that this module encodes.
java.lang.String	toString()
int	widthInBars() Returns the underlying total width of the bars from the bar specification (that is, the sum of original bar widths in base bar units).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

bars

protected final int[] bars

The specification of bars that makes up this module, in a list of bar widths in on, off order)

Constructor Detail

Module

public Module(int[] bars)

Constructs a new Module with the given bar specification.

Parameters:

bars - The bar specification

Method Detail

getSymbol

public java.lang.String getSymbol()

Returns the symbol being encoded by this module.

Returns:

The symbol encoded by this module

setSymbol

public void setSymbol(java.lang.String symbol)

Sets the symbol that this module encodes.

Parameters:

symbol - The symbol being encoded by this module

widthInBars

public int widthInBars()

Returns the underlying total width of the bars from the bar specification (that is, the sum of original bar widths in base bar units).

Returns:

The total width of bars in base (unscaled) units

draw

protected int draw(Output output,
                   int x,
                   int y,
                   int barWidth,
                   int barHeight)
            throws OutputException

Draws the module to the given outputter at the specified origin.

Parameters:

output - The outputter to draw to

x - The X component of the origin

y - The Y component of the origin

barWidth -

barHeight -

Returns:

The total width drawn

Throws:

OutputException

equals

public boolean equals(java.lang.Object o)

See Object.

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Returns:

a hash code value for this object.

See Also:

Object.equals(Object)

toString

public java.lang.String toString()