Class PdfArray

java.lang.Object
com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfObject
com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfArray
Direct Known Subclasses:
PdfBorderArray, PdfColor, PdfDashPattern, PdfDestination, PdfRectangle
public class PdfArray extends PdfObject
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.3' section 4.6 (page 40).

See Also:

  • Field Details

    • arrayList

      protected ArrayList arrayList
      this is the actual array of PdfObjects

  • Constructor Details

    • PdfArray

      public PdfArray()
      Constructs an empty PdfArray-object.

    • PdfArray

      public PdfArray(PdfObject object)
      Constructs an PdfArray-object, containing 1 PdfObject.
      Parameters:
      object - a PdfObject that has to be added to the array

    • PdfArray

      public PdfArray(float[] values)

    • PdfArray

      public PdfArray(int[] values)

    • PdfArray

      public PdfArray(ArrayList l)
      Constructs a PdfArray, containing all elements of a specified ArrayList.
      Parameters:
      l - an ArrayList with PdfObjects to be added to the array
      Throws:
      ClassCastException - if the ArrayList contains something that isn't a PdfObject
      Since:
      2.1.3

    • PdfArray

      public PdfArray(PdfArray array)
      Constructs an PdfArray-object, containing all the PdfObjects in a given PdfArray.
      Parameters:
      array - a PdfArray that has to be added to the array

  • Method Details

    • toPdf

      public void toPdf(PdfWriter writer, OutputStream os) throws IOException
      Returns the PDF representation of this PdfArray.
      Overrides:
      toPdf in class PdfObject
      Parameters:
      writer - for backwards compatibility
      os - the outputstream to write the bytes to.
      Throws:
      IOException

    • toString

      public String toString()
      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).
      Overrides:
      toString in class PdfObject
      Returns:
      the string representation of this PdfArray

    • set

      public PdfObject set(int idx, PdfObject obj)
      Overwrites a specified location of the array, returning the previous value
      Parameters:
      idx - The index of the element to be overwritten
      obj - new value for the specified index
      Returns:
      the previous value
      Throws:
      IndexOutOfBoundsException - if the specified position doesn't exist
      Since:
      2.1.5

    • remove

      public PdfObject remove(int idx)
      Remove the element at the specified position from the array. Shifts any subsequent elements to the left (subtracts one from their indices).
      Parameters:
      idx - The index of the element to be removed.
      Throws:
      IndexOutOfBoundsException - the specified position doesn't exist
      Since:
      2.1.5

    • getArrayList

      public ArrayList getArrayList()
      Returns an ArrayList containing PdfObjects.
      Returns:
      an ArrayList

    • size

      public int size()
      Returns the number of entries in the array.
      Returns:
      the size of the ArrayList

    • isEmpty

      public boolean isEmpty()
      Returns true if the array is empty.
      Returns:
      true if the array is empty
      Since:
      2.1.5

    • add

      public boolean add(PdfObject object)
      Adds a PdfObject to the PdfArray.
      Parameters:
      object - PdfObject to add
      Returns:
      true

    • add

      public boolean add(float[] values)

    • add

      public boolean add(int[] values)

    • add

      public void add(int index, PdfObject element)
      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).
      Parameters:
      index - The index at which the specified element is to be inserted
      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

    • addFirst

      public void addFirst(PdfObject object)
      Adds a PdfObject to the PdfArray.

      The newly added object will be the first element in the ArrayList.

      Parameters:
      object - PdfObject to add

    • contains

      public boolean contains(PdfObject object)
      Checks if the PdfArray already contains a certain PdfObject.
      Parameters:
      object - PdfObject to check
      Returns:
      true

    • listIterator

      public ListIterator listIterator()

    • getPdfObject

      public PdfObject getPdfObject(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      A PdfObject

    • getDirectObject

      public PdfObject getDirectObject(int 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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      A direct PdfObject or null

    • getAsDict

      public PdfDictionary getAsDict(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfDictionary object, or null

    • getAsArray

      public PdfArray getAsArray(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfArray object, or null

    • getAsStream

      public PdfStream getAsStream(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfStream object, or null

    • getAsString

      public PdfString getAsString(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfString object, or null

    • getAsNumber

      public PdfNumber getAsNumber(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfNumber object, or null

    • getAsName

      public PdfName getAsName(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfName object, or null

    • getAsBoolean

      public PdfBoolean getAsBoolean(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfBoolean object, or null

    • getAsIndirectObject

      public PdfIndirectReference getAsIndirectObject(int idx)
      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.
      Parameters:
      idx - The index of the PdfObject to be returned
      Returns:
      the corresponding PdfIndirectReference object, or null