Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| fop 2.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.fop.pdf
Class PDFArray

    java.lang.Object
      org.apache.fop.pdf.PDFObject
          org.apache.fop.pdf.PDFArray

All Implemented Interfaces:
  PDFWritable

Direct Known Subclasses:
  PDFCIELabColorSpace, PDFSeparationColorSpace

    public class PDFArray

extends PDFObject

Class representing an array object.

Field Summary
`protected java.util.List<java.lang.Object>` | `values` List holding the values of this array

Fields inherited from class org.apache.fop.pdf.PDFObject
`log`

Constructor Summary
`PDFArray()` Create a new, empty array object with no parent.
`PDFArray(java.util.List<?> elements)` Creates an array object made of the given elements.
`PDFArray(java.lang.Object... elements)` Creates an array object made of the given elements.
`PDFArray(PDFObject parent)` Create a new, empty array object
`PDFArray(PDFObject parent, double[] values)` Create an array object.
`PDFArray(PDFObject parent, int[] values)` Create an array object.
`PDFArray(PDFObject parent, java.util.List<?> values)` Create an array object.
`PDFArray(PDFObject parent, java.lang.Object[] values)` Create the array object

Method Summary
`void` | `add(double value)` Adds a new value to the array.
`void` | `add(java.lang.Object obj)` Adds a new value to the array.
`void` | `clear()` Clears the PDF array.
`boolean` | `contains(java.lang.Object obj)` Indicates whether the given object exists in the array.
`java.lang.Object` | `get(int index)` Gets an entry at a given location.
`void` | `getChildren(java.util.Set<PDFObject> children)`
`int` | `length()` Returns the length of the array
`int` | `output(java.io.OutputStream stream)` Write the PDF represention of this object
`void` | `set(int index, double value)` Sets an entry at a given location.
`void` | `set(int index, java.lang.Object obj)` Sets an entry at a given location.

Methods inherited from class org.apache.fop.pdf.PDFObject
`contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### values

    protected java.util.List<java.lang.Object> values

  List holding the values of this array

Constructor Detail

### PDFArray

    public PDFArray(PDFObject parent)

  Create a new, empty array object

  Parameters:
    `parent` - the array's parent if any

### PDFArray

    public PDFArray()

  Create a new, empty array object with no parent.

### PDFArray

    public PDFArray(PDFObject parent,
                    int[] values)

  Create an array object.

  Parameters:
    `parent` - the array's parent if any
    `values` - the actual array wrapped by this object

### PDFArray

    public PDFArray(PDFObject parent,
                    double[] values)

  Create an array object.

  Parameters:
    `parent` - the array's parent if any
    `values` - the actual array wrapped by this object

### PDFArray

    public PDFArray(PDFObject parent,
                    java.util.List<?> values)

  Create an array object.

  Parameters:
    `parent` - the array's parent if any
    `values` - the actual values wrapped by this object

### PDFArray

    public PDFArray(java.lang.Object... elements)

  Creates an array object made of the given elements.

  Parameters:
    `elements` - the array content

### PDFArray

    public PDFArray(java.util.List<?> elements)

  Creates an array object made of the given elements.

  Parameters:
    `elements` - the array content

### PDFArray

    public PDFArray(PDFObject parent,
                    java.lang.Object[] values)

  Create the array object

  Parameters:
    `parent` - the array's parent if any
    `values` - the actual array wrapped by this object

Method Detail

### contains

    public boolean contains(java.lang.Object obj)

  Indicates whether the given object exists in the array.

  Parameters:
    `obj` - the object to look for
  Returns:
    true if obj is contained

### length

    public int length()

  Returns the length of the array

  Returns:
    the length of the array

### set

    public void set(int index,
                    java.lang.Object obj)

  Sets an entry at a given location.

  Parameters:
    `index` - the index of the value to set
    `obj` - the new value

### set

    public void set(int index,
                    double value)

  Sets an entry at a given location.

  Parameters:
    `index` - the index of the value to set
    `value` - the new value

### get

    public java.lang.Object get(int index)

  Gets an entry at a given location.

  Parameters:
    `index` - the index of the value to set
  Returns:
    the requested value

### add

    public void add(java.lang.Object obj)

  Adds a new value to the array.

  Parameters:
    `obj` - the value

### add

    public void add(double value)

  Adds a new value to the array.

  Parameters:
    `value` - the value

### clear

    public void clear()

  Clears the PDF array.

### output

    public int output(java.io.OutputStream stream)
               throws java.io.IOException

  Write the PDF represention of this object

  Overrides:
    `output` in class `PDFObject`
  Parameters:
    `stream` - the stream to write the PDF to
  Returns:
    the number of bytes written
  Throws:
    `java.io.IOException` - if there is an error writing to the stream

### getChildren

    public void getChildren(java.util.Set<PDFObject> children)

  Overrides:
    `getChildren` in class `PDFObject`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| fop 2.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 1999-2016 The Apache Software Foundation. All Rights Reserved.