Package org.apache.fop.pdf
Class AbstractPDFStream
java.lang.Object
org.apache.fop.pdf.PDFObject
org.apache.fop.pdf.AbstractPDFStream
- All Implemented Interfaces:
PDFWritable
- Direct Known Subclasses:
AbstractPDFFontStream
,PDFStream
,PDFXObject
This is an abstract base class for PDF streams.
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
protected
AbstractPDFStream
(boolean encodeOnTheFly) protected
AbstractPDFStream
(PDFDictionary dictionary) protected
AbstractPDFStream
(PDFDictionary dictionary, boolean encodeOnTheFly) -
Method Summary
Modifier and TypeMethodDescriptionprotected int
encodeAndWriteStream
(OutputStream out, PDFNumber refLength) Encodes and writes a stream directly to an OutputStream.protected StreamCache
Encodes the raw data stream for output to a PDF file.void
getChildren
(Set<PDFObject> children) protected String
Returns the name of a suitable filter for this PDF object.protected final PDFDictionary
Returns the associated filter list.protected abstract int
Returns a value that hints at the size of the encoded stream.protected boolean
Whether multiple filters can be applied.int
output
(OutputStream stream) Overload the base object method so we don't have to copy byte arrays around so much Write the PDF represention of this objectprotected abstract void
Sends the raw stream data to the target OutputStream.protected int
outputStreamData
(StreamCache encodedStream, OutputStream out) Output just the stream data enclosed by stream/endstream markersprotected void
populateStreamDict
(Object lengthEntry) Populates the dictionary with all necessary entries for the stream.protected void
Prepares implicit filters (such as the DCTFilter for JPEG images).void
Puts the given object in the dictionary associated to this stream.void
void
setDocument
(PDFDocument doc) Sets the parent PDFDocument.protected void
Sets up the default filters for this stream if they haven't been set from outside.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, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString
-
Constructor Details
-
AbstractPDFStream
protected AbstractPDFStream() -
AbstractPDFStream
-
AbstractPDFStream
protected AbstractPDFStream(boolean encodeOnTheFly) -
AbstractPDFStream
-
-
Method Details
-
getDictionary
-
get
-
put
Puts the given object in the dictionary associated to this stream.- Parameters:
key
- the key in the dictionaryvalue
- the value to store
-
setupFilterList
protected void setupFilterList()Sets up the default filters for this stream if they haven't been set from outside. -
getDefaultFilterName
Returns the name of a suitable filter for this PDF object.- Returns:
- the default filter
- See Also:
-
getFilterList
Returns the associated filter list.- Returns:
- the filter list
-
getSizeHint
Returns a value that hints at the size of the encoded stream. This is used to optimize buffer allocation so fewer buffer reallocations are necessary.- Returns:
- an estimated size (0 if no hint can be given)
- Throws:
IOException
- in case of an I/O problem
-
outputRawStreamData
Sends the raw stream data to the target OutputStream.- Parameters:
out
- OutputStream to write to- Throws:
IOException
- In case of an I/O problem
-
outputStreamData
Output just the stream data enclosed by stream/endstream markers- Parameters:
encodedStream
- already encoded/filtered stream to writeout
- OutputStream to write to- Returns:
- int number of bytes written
- Throws:
IOException
- in case of an I/O problem
-
encodeStream
Encodes the raw data stream for output to a PDF file.- Returns:
- the encoded stream
- Throws:
IOException
- in case of an I/O problem
-
encodeAndWriteStream
Encodes and writes a stream directly to an OutputStream. The length of the stream, in this case, is set on a PDFNumber object that has to be prepared beforehand.- Parameters:
out
- OutputStream to write torefLength
- PDFNumber object to receive the stream length- Returns:
- number of bytes written (header and trailer included)
- Throws:
IOException
- in case of an I/O problem
-
output
Overload the base object method so we don't have to copy byte arrays around so much Write the PDF represention of this object- Overrides:
output
in classPDFObject
- Parameters:
stream
- the stream to write the PDF to- Returns:
- the number of bytes written
- Throws:
IOException
- if there is an error writing to the stream
-
setDocument
Description copied from class:PDFObject
Sets the parent PDFDocument.- Overrides:
setDocument
in classPDFObject
- Parameters:
doc
- the PDFDocument.
-
populateStreamDict
Populates the dictionary with all necessary entries for the stream. Override this method if you need additional entries.- Parameters:
lengthEntry
- value for the /Length entry
-
prepareImplicitFilters
protected void prepareImplicitFilters()Prepares implicit filters (such as the DCTFilter for JPEG images). You must make sure that the appropriate filters are in the filter list at the right places. -
multipleFiltersAllowed
protected boolean multipleFiltersAllowed()Whether multiple filters can be applied.- Returns:
- true if multiple filters allowed
-
getChildren
- Overrides:
getChildren
in classPDFObject
-
registerChildren
public void registerChildren()
-