com.etymon.pjx

Class PdfArray

java.lang.Object

com.etymon.pjx.PdfObject

com.etymon.pjx.PdfArray

All Implemented Interfaces:

java.lang.Cloneable

public class PdfArray
extends PdfObject

Represents the PDF array object.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	_a The contents of the array.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfArray() A protected constructor intended to be called only from wrap(List).
	PdfArray(java.util.List a) Constructs an array object from a list of PdfObject instances.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares this instance with another PDF object for equality.
protected PdfObject	filterContents(PdfObjectFilter f) Second stage filtering, called by filter(PdfObjectFilter).
java.util.List	getList() Returns the list of elements contained in this array.
int	hashCode() Returns a hash code for this object.
protected static PdfArray	wrap(java.util.List a) A factory for fast construction of this class.
protected int	writePdf(PdfWriter w, boolean spacing) Writes this object in PDF format.

Methods inherited from class com.etymon.pjx.PdfObject

clone, filter, toString

Methods inherited from class java.lang.Object

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

Field Detail

_a

protected java.util.List _a

The contents of the array.

Constructor Detail

PdfArray

protected PdfArray()

A protected constructor intended to be called only from wrap(List).

PdfArray

public PdfArray(java.util.List a)

Constructs an array object from a list of PdfObject instances.

Parameters:

a - the list containing the PdfObject instances.

Method Detail

filterContents

protected PdfObject filterContents(PdfObjectFilter f)
                            throws PdfFormatException

Description copied from class: PdfObject

Second stage filtering, called by filter(PdfObjectFilter). This is only called if PdfObjectFilter.preFilter(PdfObject) did not return null.

Overrides:

filterContents in class PdfObject

Returns:

the new filtered object.

Throws:

PdfFormatException

equals

public boolean equals(java.lang.Object obj)

Description copied from class: PdfObject

Compares this instance with another PDF object for equality.

Overrides:

equals in class PdfObject

Parameters:

obj - the object to compare this instance with.

Returns:

true if the PDF objects are equal.

getList

public java.util.List getList()

Returns the list of elements contained in this array.

Returns:

the list of elements. The returned List object is unmodifiable.

hashCode

public int hashCode()

Description copied from class: PdfObject

Returns a hash code for this object.

Overrides:

hashCode in class PdfObject

Returns:

the hash code.

wrap

protected static PdfArray wrap(java.util.List a)

A factory for fast construction of this class. The constructed object will be a wrapper around the specified List. The calling method must ensure that the List is never externally modified, in order to meet the immutability requirement of PdfObject.

Parameters:

a - the List to be used to back this array.

Returns:

the constructed object.

writePdf

protected int writePdf(PdfWriter w,
                       boolean spacing)
                throws java.io.IOException

Description copied from class: PdfObject

Writes this object in PDF format.

Specified by:

writePdf in class PdfObject

Parameters:

w - the PdfWriter to write to.

spacing - specifies whether to add white-space before the object. A value of true enables the addition of white-space. If the object begins with a PDF delimiter, then this option is ignored and no white-space is written.

Returns:

the number of bytes written by this method.

Throws:

java.io.IOException