Package org.apache.pdfbox.cos

Class COSArray

java.lang.Object

org.apache.pdfbox.cos.COSBase

org.apache.pdfbox.cos.COSArray

All Implemented Interfaces:

java.lang.Iterable<COSBase>, COSUpdateInfo, COSObjectable

public class COSArray
extends COSBase
implements java.lang.Iterable<COSBase>, COSUpdateInfo

An array of PDFBase objects as part of the PDF document.

Author:

Ben Litchfield

Constructor Summary

Constructors

Constructor	Description
COSArray()	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(ICOSVisitor visitor)	visitor pattern double dispatch method.
void	add(int i, COSBase object)	Add the specified object at the ith location and push the rest to the right.
void	add(COSBase object)	This will add an object to the array.
void	add(COSObjectable object)	This will add an object to the array.
void	addAll(int i, java.util.Collection<COSBase> objectList)	Add the specified object at the ith location and push the rest to the right.
void	addAll(java.util.Collection<COSBase> objectsList)	This will add an object to the array.
void	addAll(COSArray objectList)	This will add all objects to this array.
void	clear()	This will remove all of the objects in the collection.
COSBase	get(int index)	This will get an object from the array.
int	getInt(int index)	Get the value of the array as an integer.
int	getInt(int index, int defaultValue)	Get the value of the array as an integer, return the default if it does not exist.
java.lang.String	getName(int index)	Get the value of the array as a string.
java.lang.String	getName(int index, java.lang.String defaultValue)	Get an entry in the array that is expected to be a COSName.
COSBase	getObject(int index)	This will get an object from the array.
java.lang.String	getString(int index)	Get the value of the array as a string.
java.lang.String	getString(int index, java.lang.String defaultValue)	Get an entry in the array that is expected to be a COSName.
void	growToSize(int size)	This will add null values until the size of the array is at least as large as the parameter.
void	growToSize(int size, COSBase object)	This will add the object until the size of the array is at least as large as the parameter.
int	indexOf(COSBase object)	This will return the index of the entry or -1 if it is not found.
int	indexOfObject(COSBase object)	This will return the index of the entry or -1 if it is not found.
boolean	isNeedToBeUpdated()	Get the update state for the COSWriter.
java.util.Iterator<COSBase>	iterator()	Get access to the list.
COSBase	remove(int i)	This will remove an element from the array.
boolean	remove(COSBase o)	This will remove an element from the array.
void	removeAll(java.util.Collection<COSBase> objectsList)	This will remove all of the objects in the collection.
boolean	removeObject(COSBase o)	This will remove an element from the array.
void	retainAll(java.util.Collection<COSBase> objectsList)	This will retain all of the objects in the collection.
void	set(int index, int intVal)	This will set an object at a specific index.
void	set(int index, COSBase object)	This will set an object at a specific index.
void	set(int index, COSObjectable object)	This will set an object at a specific index.
void	setFloatArray(float[] value)	Clear the current contents of the COSArray and set it with the float[].
void	setInt(int index, int value)	Set the value in the array as an integer.
void	setName(int index, java.lang.String name)	Set the value in the array as a name.
void	setNeedToBeUpdated(boolean flag)	Set the update state of the dictionary for the COSWriter.
void	setString(int index, java.lang.String string)	Set the value in the array as a string.
int	size()	This will get the size of this array.
float[]	toFloatArray()	This will take an COSArray of numbers and convert it to a float[].
java.util.List<? extends COSBase>	toList()	Return contents of COSArray as a Java List.
java.lang.String	toString()

Methods inherited from class org.apache.pdfbox.cos.COSBase

getCOSObject, isDirect, setDirect

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

COSArray

public COSArray()

Constructor.

Method Detail

add

public void add(COSBase object)

This will add an object to the array.

Parameters:

object - The object to add to the array.

add

public void add(COSObjectable object)

This will add an object to the array.

Parameters:

object - The object to add to the array.

add

public void add(int i,
                COSBase object)

Add the specified object at the ith location and push the rest to the right.

Parameters:

i - The index to add at.

object - The object to add at that index.

clear

public void clear()

This will remove all of the objects in the collection.

removeAll

public void removeAll(java.util.Collection<COSBase> objectsList)

This will remove all of the objects in the collection.

Parameters:

objectsList - The list of objects to remove from the collection.

retainAll

public void retainAll(java.util.Collection<COSBase> objectsList)

This will retain all of the objects in the collection.

Parameters:

objectsList - The list of objects to retain from the collection.

addAll

public void addAll(java.util.Collection<COSBase> objectsList)

This will add an object to the array.

Parameters:

objectsList - The object to add to the array.

addAll

public void addAll(COSArray objectList)

This will add all objects to this array.

Parameters:

objectList - The objects to add.

addAll

public void addAll(int i,
                   java.util.Collection<COSBase> objectList)

Add the specified object at the ith location and push the rest to the right.

Parameters:

i - The index to add at.

objectList - The object to add at that index.

set

public void set(int index,
                COSBase object)

This will set an object at a specific index.

Parameters:

index - zero based index into array.

object - The object to set.

set

public void set(int index,
                int intVal)

This will set an object at a specific index.

Parameters:

index - zero based index into array.

intVal - The object to set.

set

public void set(int index,
                COSObjectable object)

This will set an object at a specific index.

Parameters:

index - zero based index into array.

object - The object to set.

getObject

public COSBase getObject(int index)

This will get an object from the array. This will dereference the object. If the object is COSNull then null will be returned.

Parameters:

index - The index into the array to get the object.

Returns:

The object at the requested index.

get

public COSBase get(int index)

This will get an object from the array. This will NOT dereference the COS object.

Parameters:

index - The index into the array to get the object.

Returns:

The object at the requested index.

getInt

public int getInt(int index)

Get the value of the array as an integer.

Parameters:

index - The index into the list.

Returns:

The value at that index or -1 if does not exist.

getInt

public int getInt(int index,
                  int defaultValue)

Get the value of the array as an integer, return the default if it does not exist.

Parameters:

index - The value of the array.

defaultValue - The value to return if the value is null.

Returns:

The value at the index or the defaultValue.

setInt

public void setInt(int index,
                   int value)

Set the value in the array as an integer.

Parameters:

index - The index into the array.

value - The value to set.

setName

public void setName(int index,
                    java.lang.String name)

Set the value in the array as a name.

Parameters:

index - The index into the array.

name - The name to set in the array.

getName

public java.lang.String getName(int index)

Get the value of the array as a string.

Parameters:

index - The index into the array.

Returns:

The name converted to a string or null if it does not exist.

getName

public java.lang.String getName(int index,
                                java.lang.String defaultValue)

Get an entry in the array that is expected to be a COSName.

Parameters:

index - The index into the array.

defaultValue - The value to return if it is null.

Returns:

The value at the index or defaultValue if none is found.

setString

public void setString(int index,
                      java.lang.String string)

Set the value in the array as a string.

Parameters:

index - The index into the array.

string - The string to set in the array.

getString

public java.lang.String getString(int index)

Get the value of the array as a string.

Parameters:

index - The index into the array.

Returns:

The string or null if it does not exist.

getString

public java.lang.String getString(int index,
                                  java.lang.String defaultValue)

Get an entry in the array that is expected to be a COSName.

Parameters:

index - The index into the array.

defaultValue - The value to return if it is null.

Returns:

The value at the index or defaultValue if none is found.

size

public int size()

This will get the size of this array.

Returns:

The number of elements in the array.

remove

public COSBase remove(int i)

This will remove an element from the array.

Parameters:

i - The index of the object to remove.

Returns:

The object that was removed.

remove

public boolean remove(COSBase o)

This will remove an element from the array.

Parameters:

o - The object to remove.

Returns:

true if the object was removed, false otherwise

removeObject

public boolean removeObject(COSBase o)

This will remove an element from the array. This method will also remove a reference to the object.

Parameters:

o - The object to remove.

Returns:

true if the object was removed, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

iterator

public java.util.Iterator<COSBase> iterator()

Get access to the list.

Specified by:

iterator in interface java.lang.Iterable<COSBase>

Returns:

an iterator over the array elements

indexOf

public int indexOf(COSBase object)

This will return the index of the entry or -1 if it is not found.

Parameters:

object - The object to search for.

Returns:

The index of the object or -1.

indexOfObject

public int indexOfObject(COSBase object)

This will return the index of the entry or -1 if it is not found. This method will also find references to indirect objects.

Parameters:

object - The object to search for.

Returns:

The index of the object or -1.

growToSize

public void growToSize(int size)

This will add null values until the size of the array is at least as large as the parameter. If the array is already larger than the parameter then nothing is done.

Parameters:

size - The desired size of the array.

growToSize

public void growToSize(int size,
                       COSBase object)

This will add the object until the size of the array is at least as large as the parameter. If the array is already larger than the parameter then nothing is done.

Parameters:

size - The desired size of the array.

object - The object to fill the array with.

accept

public java.lang.Object accept(ICOSVisitor visitor)
                        throws java.io.IOException

visitor pattern double dispatch method.

Specified by:

accept in class COSBase

Parameters:

visitor - The object to notify when visiting this object.

Returns:

any object, depending on the visitor implementation, or null

Throws:

java.io.IOException - If an error occurs while visiting this object.

isNeedToBeUpdated

public boolean isNeedToBeUpdated()

Description copied from interface: COSUpdateInfo

Get the update state for the COSWriter. This indicates whether an object is to be written when there is an incremental save.

Specified by:

isNeedToBeUpdated in interface COSUpdateInfo

Returns:

the update state.

setNeedToBeUpdated

public void setNeedToBeUpdated(boolean flag)

Description copied from interface: COSUpdateInfo

Set the update state of the dictionary for the COSWriter. This indicates whether an object is to be written when there is an incremental save.

Specified by:

setNeedToBeUpdated in interface COSUpdateInfo

Parameters:

flag - the update state.

toFloatArray

public float[] toFloatArray()

This will take an COSArray of numbers and convert it to a float[].

Returns:

This COSArray as an array of float numbers.

setFloatArray

public void setFloatArray(float[] value)

Clear the current contents of the COSArray and set it with the float[].

Parameters:

value - The new value of the float array.

toList

public java.util.List<? extends COSBase> toList()

Return contents of COSArray as a Java List.

Returns:

the COSArray as List