Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.common » [javadoc | source]
org.apache.pdfbox.pdmodel.common
public class: COSStreamArray [javadoc | source]
java.lang.Object
   org.apache.pdfbox.cos.COSBase
      org.apache.pdfbox.cos.COSDictionary
         org.apache.pdfbox.cos.COSStream
            org.apache.pdfbox.pdmodel.common.COSStreamArray

All Implemented Interfaces:
    COSObjectable

This will take an array of streams and sequence them together.
Constructor:
 public COSStreamArray(COSArray array) 
    Constructor.
    Parameters:
    array - The array of COSStreams to concatenate together.
Method from org.apache.pdfbox.pdmodel.common.COSStreamArray Summary:
accept,   appendStream,   createFilteredStream,   createFilteredStream,   createUnfilteredStream,   get,   getDictionary,   getDictionaryObject,   getFilteredStream,   getFilters,   getItem,   getScratchFile,   getStreamCount,   getStreamTokens,   getUnfilteredStream,   setFilters,   toString
Methods from org.apache.pdfbox.cos.COSStream:
accept,   createFilteredStream,   createFilteredStream,   createUnfilteredStream,   getFilteredStream,   getFilters,   getScratchFile,   getStreamTokens,   getUnfilteredStream,   replaceWithStream,   setFilters
Methods from org.apache.pdfbox.cos.COSDictionary:
accept,   addAll,   clear,   containsValue,   entrySet,   getBoolean,   getBoolean,   getDate,   getDate,   getDate,   getDate,   getDictionaryObject,   getDictionaryObject,   getDictionaryObject,   getDictionaryObject,   getEmbeddedDate,   getEmbeddedDate,   getEmbeddedDate,   getEmbeddedDate,   getEmbeddedInt,   getEmbeddedInt,   getEmbeddedInt,   getEmbeddedInt,   getEmbeddedString,   getEmbeddedString,   getEmbeddedString,   getEmbeddedString,   getFloat,   getFloat,   getFloat,   getFloat,   getInt,   getInt,   getInt,   getInt,   getInt,   getItem,   getKeyForValue,   getLong,   getLong,   getLong,   getLong,   getLong,   getNameAsString,   getNameAsString,   getNameAsString,   getNameAsString,   getObjectFromPath,   getString,   getString,   getString,   getString,   getValues,   keyList,   keySet,   mergeInto,   removeItem,   setBoolean,   setBoolean,   setDate,   setDate,   setEmbeddedDate,   setEmbeddedDate,   setEmbeddedInt,   setEmbeddedInt,   setEmbeddedString,   setEmbeddedString,   setFloat,   setFloat,   setInt,   setInt,   setItem,   setItem,   setItem,   setItem,   setLong,   setLong,   setName,   setName,   setString,   setString,   size,   toString
Methods from org.apache.pdfbox.cos.COSBase:
accept,   getCOSObject,   getFilterManager
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.common.COSStreamArray Detail:
 public Object accept(ICOSVisitor visitor) throws COSVisitorException 
    visitor pattern double dispatch method.
 public  void appendStream(COSStream streamToAppend) 
    Appends a new stream to the array that represents this object's stream.
 public OutputStream createFilteredStream() throws IOException 
    This will create a new stream for which filtered byte should be written to. You probably don't want this but want to use the createUnfilteredStream, which is used to write raw bytes to.
 public OutputStream createFilteredStream(COSBase expectedLength) throws IOException 
    This will create a new stream for which filtered byte should be written to. You probably don't want this but want to use the createUnfilteredStream, which is used to write raw bytes to.
 public OutputStream createUnfilteredStream() throws IOException 
    This will create an output stream that can be written to.
 public COSBase get(int index) 
    This will get a stream (or the reference to a stream) from the array.
 public COSDictionary getDictionary() 
    This will get the dictionary that is associated with this stream.
 public COSBase getDictionaryObject(COSName key) 
    This will get an object from this streams dictionary and dereference it if necessary.
 public InputStream getFilteredStream() throws IOException 
    This will get the stream with all of the filters applied.
 public COSBase getFilters() 
    This will return the filters to apply to the byte stream the method will return. - null if no filters are to be applied - a COSName if one filter is to be applied - a COSArray containing COSNames if multiple filters are to be applied
 public COSBase getItem(COSName key) 
    This will get an object from this streams dictionary.
 public RandomAccess getScratchFile() 
    This will get the scratch file associated with this stream.
 public int getStreamCount() 
    This will get the number of streams in the array.
 public List getStreamTokens() throws IOException 
    This will get all the tokens in the stream.
 public InputStream getUnfilteredStream() throws IOException 
    This will get the logical content stream with none of the filters.
 public  void setFilters(COSBase filters) throws IOException 
    set the filters to be applied to the stream.
 public String toString() 
    {@inheritDoc}