org.pdfbox.cos

Class COSArray

Implemented Interfaces:
COSObjectable

public class COSArray
extends COSBase

An array of PDFBase objects as part of the PDF document.
Version:
$Revision: 1.24 $
Author:
Ben Litchfield

Constructor Summary

COSArray()
Constructor.

Method Summary

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(Collection objectsList)
This will add an object to the array.
void
addAll(int i, Collection objectList)
Add the specified object at the ith location and push the rest to the right.
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.
String
getName(int index)
Get the value of the array as a string.
String
getName(int index, 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.
String
getString(int index)
Get the value of the array as a string.
String
getString(int index, 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.
Iterator
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(Collection objectsList)
This will remove all of the objects in the collection.
void
retainAll(Collection 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, String name)
Set the value in the array as a name.
void
setString(int index, 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[].
String
toString()

Methods inherited from class org.pdfbox.cos.COSBase

accept, getCOSObject, getFilterManager

Constructor Details

COSArray

public COSArray()
Constructor.

Method Details

accept

public Object accept(ICOSVisitor visitor)
            throws COSVisitorException
visitor pattern double dispatch method.
Overrides:
accept in interface COSBase
Parameters:
visitor - The object to notify when visiting this object.
Returns:
any object, depending on the visitor implementation, or null
Throws:
COSVisitorException - If an error occurs while visiting this object.

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.

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.

addAll

public void addAll(Collection objectsList)
This will add an object to the array.
Parameters:
objectsList - The object to add to the array.

addAll

public void addAll(int i,
                   Collection 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.

addAll

public void addAll(COSArray objectList)
This will add all objects to this array.
Parameters:
objectList - The objects to add.

clear

public void clear()
This will remove all of the objects in the collection.

get

public COSBase get(int index)
This will get an object from the array. This will NOT derefernce 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 it is null.

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.

getName

public 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 String getName(int index,
                      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.

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.

getString

public 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 String getString(int index,
                        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.

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.

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.

iterator

public Iterator iterator()
Get access to the list.
Returns:
an iterator over the array elements

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:
The object that was removed.

removeAll

public void removeAll(Collection 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(Collection objectsList)
This will retain all of the objects in the collection.
Parameters:
objectsList - The list of objects to retain from the collection.

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,
                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,
                COSObjectable object)
This will set an object at a specific index.
Parameters:
index - zero based index into array.
object - The object to set.

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.

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,
                    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.

setString

public void setString(int index,
                      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.

size

public int size()
This will get the size of this array.
Returns:
The number of elements in the array.

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.

toString

public String toString()