com.itextpdf.kernel.pdf

Class PdfArray

java.lang.Object

com.itextpdf.kernel.pdf.PdfObject

com.itextpdf.kernel.pdf.PdfArray

All Implemented Interfaces:

Serializable, Iterable<PdfObject>

Direct Known Subclasses:

PdfTextArray

public class PdfArray
extends PdfObject
implements Iterable<PdfObject>

A representation of an array as described in the PDF specification. A PdfArray can contain any subclass of PdfObject.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<PdfObject>	list

Fields inherited from class com.itextpdf.kernel.pdf.PdfObject

ARRAY, BOOLEAN, DICTIONARY, FLUSHED, FORBID_RELEASE, FREE, INDIRECT_REFERENCE, indirectReference, LITERAL, MODIFIED, MUST_BE_FLUSHED, MUST_BE_INDIRECT, NAME, NULL, NUMBER, ORIGINAL_OBJECT_STREAM, READ_ONLY, READING, STREAM, STRING, UNENCRYPTED

Constructor Summary

Constructors

Constructor and Description
PdfArray() Create a new, empty PdfArray.
PdfArray(boolean[] values) Create a new PdfArray filled with the values in the boolean[] as PdfBoolean.
PdfArray(double[] numbers) Create a new PdfArray filled with the values in the double[] as PdfNumber.
PdfArray(float[] numbers) Create a new PdfArray filled with the values in the float[] as PdfNumber.
PdfArray(int[] numbers) Create a new PdfArray filled with the values in the int[] as PdfNumber.
PdfArray(Iterable<? extends PdfObject> objects, int initialCapacity) Create a new PdfArray.
PdfArray(List<? extends PdfObject> objects) Create a new PdfArray.
PdfArray(List<String> strings, boolean asNames) Create a new PdfArray filled with a list of Strings.
PdfArray(PdfArray arr) Create a new PdfArray.
PdfArray(PdfObject obj) Create a new PdfArray with the provided PdfObject as the first item in the array.
PdfArray(Rectangle rectangle) Create a new PdfArray.

Method Summary

Modifier and Type	Method and Description
void	add(int index, PdfObject element) Adds the specified PdfObject at the specified index.
void	add(PdfObject pdfObject)
void	addAll(Collection<PdfObject> c) Adds the Collection of PdfObjects.
void	addAll(PdfArray a) Adds content of the PdfArray.
void	clear()
boolean	contains(PdfObject o)
protected void	copyContent(PdfObject from, PdfDocument document) Copies object content from object 'from'.
PdfArray	copyTo(PdfDocument document) Copies object to a specified document.
PdfArray	copyTo(PdfDocument document, boolean allowDuplicating) Copies object to a specified document.
Iterator<PdfObject>	directIterator() Deprecated. Use iterator() instead.
PdfObject	get(int index) Gets the (direct) PdfObject at the specified index.
PdfObject	get(int index, boolean asDirect)
PdfArray	getAsArray(int index) Returns the element at the specified index as a PdfArray.
PdfBoolean	getAsBoolean(int index) Returns the element at the specified index as a PdfBoolean.
PdfDictionary	getAsDictionary(int index) Returns the element at the specified index as a PdfDictionary.
PdfName	getAsName(int index) Returns the element at the specified index as a PdfName.
PdfNumber	getAsNumber(int index) Returns the element at the specified index as a PdfNumber.
PdfStream	getAsStream(int index) Returns the element at the specified index as a PdfStream.
PdfString	getAsString(int index) Returns the element at the specified index as a PdfString.
byte	getType() Gets object type.
int	indexOf(PdfObject o) Gets the first index of the specified PdfObject.
boolean	isEmpty()
Iterator<PdfObject>	iterator() Returns an iterator over an array of PdfObject elements.
PdfArray	makeIndirect(PdfDocument document) Marks object to be saved as indirect.
PdfArray	makeIndirect(PdfDocument document, PdfIndirectReference reference) Marks object to be saved as indirect.
protected PdfArray	newInstance() Creates new instance of object.
protected void	releaseContent() Release content of PdfArray.
void	remove(int index) Removes the PdfObject at the specified index.
void	remove(PdfObject o) Removes the PdfObject at the specified index.
PdfObject	set(int index, PdfObject element) Sets the PdfObject at the specified index in the PdfArray.
int	size()
List<PdfObject>	subList(int fromIndex, int toIndex) Returns a sublist of this PdfArray, starting at fromIndex (inclusive) and ending at toIndex (exclusive).
Rectangle	toRectangle() Returns the first four elements of this array as a PdfArray.
String	toString()

Methods inherited from class com.itextpdf.kernel.pdf.PdfObject

checkState, clearState, clone, flush, flush, getIndirectReference, isArray, isBoolean, isDictionary, isFlushed, isIndirect, isIndirectReference, isLiteral, isModified, isName, isNull, isNumber, isStream, isString, release, setIndirectReference, setModified, setState

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

list

protected List<PdfObject> list

Constructor Detail

PdfArray

public PdfArray()

Create a new, empty PdfArray.

PdfArray

public PdfArray(PdfObject obj)

Create a new PdfArray with the provided PdfObject as the first item in the array.

Parameters:

obj - first item in the array

PdfArray

public PdfArray(PdfArray arr)

Create a new PdfArray. The array is filled with the items of the provided PdfArray.

Parameters:

arr - PdfArray containing items that will added to this PdfArray

PdfArray

public PdfArray(Rectangle rectangle)

Create a new PdfArray. The array is filled with the four values of the Rectangle in the follozing order: left, bottom, right, top.

Parameters:

rectangle - Rectangle whose 4 values will be added to the PdfArray

PdfArray

public PdfArray(List<? extends PdfObject> objects)

Create a new PdfArray. The PdfObjects in the list will be added to the PdfArray.

Parameters:

objects - List of PdfObjects to be added to this PdfArray

PdfArray

public PdfArray(float[] numbers)

Create a new PdfArray filled with the values in the float[] as PdfNumber.

Parameters:

numbers - values to be added to this PdfArray

PdfArray

public PdfArray(double[] numbers)

Create a new PdfArray filled with the values in the double[] as PdfNumber.

Parameters:

numbers - values to be added to this PdfArray

PdfArray

public PdfArray(int[] numbers)

Create a new PdfArray filled with the values in the int[] as PdfNumber.

Parameters:

numbers - values to be added to this PdfArray

PdfArray

public PdfArray(boolean[] values)

Create a new PdfArray filled with the values in the boolean[] as PdfBoolean.

Parameters:

values - values to be added to this PdfArray

PdfArray

public PdfArray(List<String> strings,
                boolean asNames)

Create a new PdfArray filled with a list of Strings. The boolean value decides if the Strings should be added as PdfName (true) or as PdfString (false).

Parameters:

strings - list of strings to be added to the list

asNames - indicates whether the strings should be added as PdfName (true) or as PdfString (false)

PdfArray

public PdfArray(Iterable<? extends PdfObject> objects,
                int initialCapacity)

Create a new PdfArray. The PdfObjects in the iterable object will be added to the PdfArray.

Parameters:

objects - List of PdfObjects to be added to this PdfArray

initialCapacity - Initial capacity of this PdfArray

Method Detail

size

public int size()

isEmpty

public boolean isEmpty()

contains

public boolean contains(PdfObject o)

iterator

public Iterator<PdfObject> iterator()

Returns an iterator over an array of PdfObject elements.
NOTE: since 7.0.1 it returns collection of direct objects. If you want to get PdfIndirectReference instances for the indirect objects value, you shall use get(int, boolean) method.

Specified by:

iterator in interface Iterable<PdfObject>

Returns:

an Iterator.

directIterator

@Deprecated
public Iterator<PdfObject> directIterator()

Deprecated. Use iterator() instead.

Returns an iterator over an array of PdfObject elements.

add

public void add(PdfObject pdfObject)

add

public void add(int index,
                PdfObject element)

Adds the specified PdfObject at the specified index. All objects after this index will be shifted by 1.

Parameters:

index - position to insert the PdfObject

element - PdfObject to be added

See Also:

List.add(int, Object)

set

public PdfObject set(int index,
                     PdfObject element)

Sets the PdfObject at the specified index in the PdfArray.

Parameters:

index - the position to set the PdfObject

element - PdfObject to be added

Returns:

true if the operation changed the PdfArray

See Also:

List.set(int, Object)

addAll

public void addAll(Collection<PdfObject> c)

Adds the Collection of PdfObjects.

Parameters:

c - the Collection of PdfObjects to be added

See Also:

List.addAll(java.util.Collection)

addAll

public void addAll(PdfArray a)

Adds content of the PdfArray.

Parameters:

a - the PdfArray to be added

See Also:

List.addAll(java.util.Collection)

get

public PdfObject get(int index)

Gets the (direct) PdfObject at the specified index.

Parameters:

index - index of the PdfObject in the PdfArray

Returns:

the PdfObject at the position in the PdfArray

remove

public void remove(int index)

Removes the PdfObject at the specified index.

Parameters:

index - position of the PdfObject to be removed

See Also:

List.remove(int)

remove

public void remove(PdfObject o)

Removes the PdfObject at the specified index.

Parameters:

o - a PdfObject to be removed

See Also:

List.remove(Object)

clear

public void clear()

indexOf

public int indexOf(PdfObject o)

Gets the first index of the specified PdfObject.

Parameters:

o - PdfObject to find the index of

Returns:

index of the PdfObject

See Also:

List.indexOf(Object)

subList

public List<PdfObject> subList(int fromIndex,
                               int toIndex)

Returns a sublist of this PdfArray, starting at fromIndex (inclusive) and ending at toIndex (exclusive).

Parameters:

fromIndex - the position of the first element in the sublist (inclusive)

toIndex - the position of the last element in the sublist (exclusive)

Returns:

List of PdfObjects

See Also:

List.subList(int, int)

getType

public byte getType()

Description copied from class: PdfObject

Gets object type.

Specified by:

getType in class PdfObject

Returns:

object type.

makeIndirect

public PdfArray makeIndirect(PdfDocument document)

Marks object to be saved as indirect.

Overrides:

makeIndirect in class PdfObject

Parameters:

document - a document the indirect reference will belong to.

Returns:

object itself.

makeIndirect

public PdfArray makeIndirect(PdfDocument document,
                             PdfIndirectReference reference)

Marks object to be saved as indirect.

Overrides:

makeIndirect in class PdfObject

Parameters:

document - a document the indirect reference will belong to.

Returns:

object itself.

copyTo

public PdfArray copyTo(PdfDocument document)

Copies object to a specified document. Works only for objects that are read from existing document, otherwise an exception is thrown.

Overrides:

copyTo in class PdfObject

Parameters:

document - document to copy object to.

Returns:

copied object.

copyTo

public PdfArray copyTo(PdfDocument document,
                       boolean allowDuplicating)

Copies object to a specified document. Works only for objects that are read from existing document, otherwise an exception is thrown.

Overrides:

copyTo in class PdfObject

Parameters:

document - document to copy object to.

allowDuplicating - indicates if to allow copy objects which already have been copied. If object is associated with any indirect reference and allowDuplicating is false then already existing reference will be returned instead of copying object. If allowDuplicating is true then object will be copied and new indirect reference will be assigned.

Returns:

copied object.

toString

public String toString()

Overrides:

toString in class Object

get

public PdfObject get(int index,
                     boolean asDirect)

Parameters:

asDirect - true is to extract direct object always.

getAsArray

public PdfArray getAsArray(int index)

Returns the element at the specified index as a PdfArray. If the element isn't a PdfArray, null is returned.

Parameters:

index - position of the element to be returned

Returns:

the element at the index as a PdfArray

getAsDictionary

public PdfDictionary getAsDictionary(int index)

Returns the element at the specified index as a PdfDictionary. If the element isn't a PdfDictionary, null is returned.

Parameters:

index - position of the element to be returned

Returns:

the element at the index as a PdfDictionary

getAsStream

public PdfStream getAsStream(int index)

Returns the element at the specified index as a PdfStream. If the element isn't a PdfStream, null is returned.

Parameters:

index - position of the element to be returned

Returns:

the element at the index as a PdfStream

getAsNumber

public PdfNumber getAsNumber(int index)

Returns the element at the specified index as a PdfNumber. If the element isn't a PdfNumber, null is returned.

Parameters:

index - position of the element to be returned

Returns:

the element at the index as a PdfNumber

getAsName

public PdfName getAsName(int index)

Returns the element at the specified index as a PdfName. If the element isn't a PdfName, null is returned.

Parameters:

index - position of the element to be returned

Returns:

the element at the index as a PdfName

getAsString

public PdfString getAsString(int index)

Returns the element at the specified index as a PdfString. If the element isn't a PdfString, null is returned.

Parameters:

index - position of the element to be returned

Returns:

the element at the index as a PdfString

getAsBoolean

public PdfBoolean getAsBoolean(int index)

Returns the element at the specified index as a PdfBoolean. If the element isn't a PdfBoolean, null is returned.

Parameters:

index - position of the element to be returned

Returns:

the element at the index as a PdfBoolean

toRectangle

public Rectangle toRectangle()

Returns the first four elements of this array as a PdfArray. The first four values need to be PdfNumbers, if not a PdfException will be thrown.

Returns:

Rectangle of the first four values

Throws:

PdfException - if one of the first values isn't a PdfNumber

newInstance

protected PdfArray newInstance()

Description copied from class: PdfObject

Creates new instance of object.

Specified by:

newInstance in class PdfObject

Returns:

new instance of object.

copyContent

protected void copyContent(PdfObject from,
                           PdfDocument document)

Description copied from class: PdfObject

Copies object content from object 'from'.

Overrides:

copyContent in class PdfObject

Parameters:

from - object to copy content from.

document - document to copy object to.

releaseContent

protected void releaseContent()

Release content of PdfArray.