com.lowagie.text.pdf.PdfArray Maven / Gradle / Ivy
/*
* $Id: PdfArray.java 3761 2009-03-06 16:33:57Z blowagie $
*
* Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* https://github.com/LibrePDF/OpenPDF
*/
package com.lowagie.text.pdf;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
/**
* PdfArray is the PDF Array object.
*
* An array is a sequence of PDF objects. An array may contain a mixture of
* object types. An array is written as a left square bracket ([), followed by a
* sequence of objects, followed by a right square bracket (]).
* This object is described in the 'Portable Document Format Reference Manual
* version 1.7' section 3.2.5 (page 58).
*
* @see PdfObject
*/
public class PdfArray extends PdfObject {
// CLASS VARIABLES
/** this is the actual array of PdfObjects */
protected List arrayList;
// constructors
/**
* Constructs an empty PdfArray-object.
*/
public PdfArray() {
super(ARRAY);
arrayList = new ArrayList<>();
}
/**
* Constructs an PdfArray-object, containing 1
* PdfObject.
*
* @param object
* a PdfObject that has to be added to the array
*/
public PdfArray(PdfObject object) {
this();
arrayList.add(object);
}
/**
* Constructs a PdfArray-object, containing all
* float values in a specified array.
*
* The float values are internally converted to
* PdfNumber objects.
*
* @param values
* an array of float values to be added
*/
public PdfArray(float[] values) {
this();
add(values);
}
/**
* Constructs a PdfArray-object, containing all
* int values in a specified array.
*
* The int values are internally converted to
* PdfNumber objects.
*
* @param values
* an array of int values to be added
*/
public PdfArray(int[] values) {
this();
add(values);
}
/**
* Constructs a PdfArray, containing all elements of a
* specified List.
*
* @param pdfObjectList
* an List with PdfObjects to be
* added to the array
* @since 2.1.3
*/
public PdfArray(List pdfObjectList) {
this();
if (pdfObjectList != null) {
arrayList.addAll(pdfObjectList);
}
}
/**
* Constructs an PdfArray-object, containing all
* PdfObjects in a specified PdfArray.
*
* @param array
* a PdfArray to be added to the array
*/
public PdfArray(PdfArray array) {
this(array.getElements());
}
// METHODS OVERRIDING SOME PDFOBJECT METHODS
/**
* Writes the PDF representation of this PdfArray as an array
* of byte to the specified OutputStream.
*
* @param writer
* for backwards compatibility
* @param os
* the OutputStream to write the bytes to.
*/
@Override
public void toPdf(PdfWriter writer, OutputStream os) throws IOException {
os.write('[');
Iterator i = arrayList.iterator();
PdfObject object;
int type;
if (i.hasNext()) {
object = i.next();
if (object == null) {
object = PdfNull.PDFNULL;
}
object.toPdf(writer, os);
}
while (i.hasNext()) {
object = i.next();
if (object == null) {
object = PdfNull.PDFNULL;
}
type = object.type();
if (type != PdfObject.ARRAY && type != PdfObject.DICTIONARY
&& type != PdfObject.NAME && type != PdfObject.STRING) {
os.write(' ');
}
object.toPdf(writer, os);
}
os.write(']');
}
/**
* Returns a string representation of this PdfArray.
*
* The string representation consists of a list of all
* PdfObjects contained in this PdfArray, enclosed
* in square brackets ("[]"). Adjacent elements are separated by the
* characters ", " (comma and space).
*
* @return the string representation of this PdfArray
*/
@Override
public String toString() {
return arrayList.toString();
}
// ARRAY CONTENT METHODS
/**
* Overwrites a specified location of the array, returning the previous
* value
*
* @param idx
* The index of the element to be overwritten
* @param obj
* new value for the specified index
* @throws IndexOutOfBoundsException
* if the specified position doesn't exist
* @return the previous value
* @since 2.1.5
*/
public PdfObject set(int idx, PdfObject obj) {
return arrayList.set(idx, obj);
}
/**
* Remove the element at the specified position from the array.
*
* Shifts any subsequent elements to the left (subtracts one from their
* indices).
*
* @param idx
* The index of the element to be removed.
* @throws IndexOutOfBoundsException
* the specified position doesn't exist
* @since 2.1.5
* @return the PdfObject that was removed
*/
public PdfObject remove(int idx) {
return arrayList.remove(idx);
}
/**
* Removes the element from the list.
*
* Shifts any subsequent elements to the left (subtracts one from their
* indices).
*
* @param object to be removed.
*/
public boolean remove(PdfObject object) {
return this.arrayList.remove(object);
}
/**
* Get a copy the internal list for this PdfArray.
*
* @deprecated Please use getElements() instead.
* @return a copy of the the internal List.
*/
@Deprecated
public List getArrayList() {
return getElements();
}
/**
* Get a copy the internal list for this PdfArray.
*
* @return a copy of the the internal List.
*/
public List getElements() {
return new ArrayList<>(arrayList);
}
/**
* Returns the number of entries in the array.
*
* @return the size of the List
*/
public int size() {
return arrayList.size();
}
/**
* Returns true if the array is empty.
*
* @return true if the array is empty
* @since 2.1.5
*/
public boolean isEmpty() {
return arrayList.isEmpty();
}
/**
* Adds a PdfObject to the end of the PdfArray.
*
* The PdfObject will be the last element.
*
* @param object
* PdfObject to add
* @return always true
*/
public boolean add(PdfObject object) {
return arrayList.add(object);
}
/**
* Adds an array of float values to end of the
* PdfArray.
*
* The values will be the last elements. The float values are
* internally converted to PdfNumber objects.
*
* @param values
* An array of float values to add
* @return always true
*/
public boolean add(float[] values) {
for (float value : values) {
arrayList.add(new PdfNumber(value));
}
return true;
}
/**
* Adds an array of int values to end of the
* PdfArray.
*
* The values will be the last elements. The int values are
* internally converted to PdfNumber objects.
*
* @param values
* An array of int values to add
* @return always true
*/
public boolean add(int[] values) {
for (int value : values) {
arrayList.add(new PdfNumber(value));
}
return true;
}
/**
* Inserts the specified element at the specified position.
*
* Shifts the element currently at that position (if any) and any subsequent
* elements to the right (adds one to their indices).
*
* @param index
* The index at which the specified element is to be inserted
* @param element
* The element to be inserted
* @throws IndexOutOfBoundsException
* if the specified index is larger than the last position
* currently set, plus 1.
* @since 2.1.5
*/
public void add(int index, PdfObject element) {
arrayList.add(index, element);
}
/**
* Inserts a PdfObject at the beginning of the
* PdfArray.
*
* The PdfObject will be the first element, any other elements
* will be shifted to the right (adds one to their indices).
*
* @param object
* The PdfObject to add
*/
public void addFirst(PdfObject object) {
arrayList.add(0, object);
}
/**
* Checks if the PdfArray already contains a certain
* PdfObject.
*
* @param object
* The PdfObject to check
* @return true
*/
public boolean contains(PdfObject object) {
return arrayList.contains(object);
}
/**
* Returns the list iterator for the array.
*
* @return a ListIterator
*/
public ListIterator listIterator() {
return arrayList.listIterator();
}
/**
* Returns the PdfObject with the specified index.
*
* A possible indirect references is not resolved, so the returned
* PdfObject may be either a direct object or an indirect
* reference, depending on how the object is stored in the
* PdfArray.
*
* @param idx
* The index of the PdfObject to be returned
* @return A PdfObject
*/
public PdfObject getPdfObject(int idx) {
return arrayList.get(idx);
}
/**
* Returns the PdfObject with the specified index, resolving a
* possible indirect reference to a direct object.
*
* Thus this method will never return a PdfIndirectReference
* object.
*
* @param idx
* The index of the PdfObject to be returned
* @return A direct PdfObject or null
*/
public PdfObject getDirectObject(int idx) {
return PdfReader.getPdfObject(getPdfObject(idx));
}
// DOWNCASTING GETTERS
// @author Mark A Storer (2/17/06)
/**
* Returns a PdfObject as a PdfDictionary,
* resolving indirect references.
*
* The object corresponding to the specified index is retrieved and
* resolvedto a direct object. If it is a PdfDictionary, it is
* cast down and returned as such. Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfDictionary object, or
* null
*/
public PdfDictionary getAsDict(int idx) {
PdfDictionary dict = null;
PdfObject orig = getDirectObject(idx);
if (orig != null && orig.isDictionary()) {
dict = (PdfDictionary) orig;
}
return dict;
}
/**
* Returns a PdfObject as a PdfArray, resolving
* indirect references.
*
* The object corresponding to the specified index is retrieved and resolved
* to a direct object. If it is a PdfArray, it is cast down and
* returned as such. Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfArray object, or
* null
*/
public PdfArray getAsArray(int idx) {
PdfArray array = null;
PdfObject orig = getDirectObject(idx);
if (orig != null && orig.isArray()) {
array = (PdfArray) orig;
}
return array;
}
/**
* Returns a PdfObject as a PdfStream, resolving
* indirect references.
*
* The object corresponding to the specified index is retrieved and resolved
* to a direct object. If it is a PdfStream, it is cast down
* and returned as such. Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfStream object, or
* null
*/
public PdfStream getAsStream(int idx) {
PdfStream stream = null;
PdfObject orig = getDirectObject(idx);
if (orig != null && orig.isStream()) {
stream = (PdfStream) orig;
}
return stream;
}
/**
* Returns a PdfObject as a PdfString, resolving
* indirect references.
*
* The object corresponding to the specified index is retrieved and resolved
* to a direct object. If it is a PdfString, it is cast down
* and returned as such. Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfString object, or
* null
*/
public PdfString getAsString(int idx) {
PdfString string = null;
PdfObject orig = getDirectObject(idx);
if (orig != null && orig.isString()) {
string = (PdfString) orig;
}
return string;
}
/**
* Returns a PdfObject as a PdfNumber, resolving
* indirect references.
*
* The object corresponding to the specified index is retrieved and resolved
* to a direct object. If it is a PdfNumber, it is cast down
* and returned as such. Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfNumber object, or
* null
*/
public PdfNumber getAsNumber(int idx) {
PdfNumber number = null;
PdfObject orig = getDirectObject(idx);
if (orig != null && orig.isNumber()) {
number = (PdfNumber) orig;
}
return number;
}
/**
* Returns a PdfObject as a PdfName, resolving
* indirect references.
*
* The object corresponding to the specified index is retrieved and resolved
* to a direct object. If it is a PdfName, it is cast down and
* returned as such. Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfName object, or
* null
*/
public PdfName getAsName(int idx) {
PdfName name = null;
PdfObject orig = getDirectObject(idx);
if (orig != null && orig.isName()) {
name = (PdfName) orig;
}
return name;
}
/**
* Returns a PdfObject as a PdfBoolean, resolving
* indirect references.
*
* The object corresponding to the specified index is retrieved and resolved
* to a direct object. If it is a PdfBoolean, it is cast down
* and returned as such. Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfBoolean object, or
* null
*/
public PdfBoolean getAsBoolean(int idx) {
PdfBoolean bool = null;
PdfObject orig = getDirectObject(idx);
if (orig != null && orig.isBoolean()) {
bool = (PdfBoolean) orig;
}
return bool;
}
/**
* Returns a PdfObject as a PdfIndirectReference.
*
* The object corresponding to the specified index is retrieved. If it is a
* PdfIndirectReference, it is cast down and returned as such.
* Otherwise null is returned.
*
* @param idx
* The index of the PdfObject to be returned
* @return the corresponding PdfIndirectReference object, or
* null
*/
public PdfIndirectReference getAsIndirectObject(int idx) {
PdfIndirectReference ref = null;
PdfObject orig = getPdfObject(idx); // not getDirect this time.
if (orig != null && orig.isIndirect()) {
ref = (PdfIndirectReference) orig;
}
return ref;
}
}