| Package | Description | 
|---|---|
| org.apache.pdfbox.cos | 
 These are the low level objects that make up a PDF document. 
 | 
| org.apache.pdfbox.debugger.streampane | |
| org.apache.pdfbox.pdfparser | 
 The pdfparser package contains classes to parse PDF documents and objects within the document. 
 | 
| org.apache.pdfbox.pdfwriter | 
 This is the persistence layer used to write the PDFBox documents to a stream. 
 | 
| org.apache.pdfbox.pdmodel.common | 
 High level PD classes that are used throughout several packages are placed in the PDModel common package. 
 | 
| org.apache.pdfbox.pdmodel.common.filespecification | 
 The file specification package defines classes that are used for the PDF File Specification logic. 
 | 
| org.apache.pdfbox.pdmodel.encryption | 
 The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers. 
 | 
| org.apache.pdfbox.pdmodel.fdf | 
 The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document. 
 | 
| org.apache.pdfbox.pdmodel.font | 
 Classes to deal with font functionality in a PDF Document. 
 | 
| org.apache.pdfbox.pdmodel.graphics | 
 The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document. 
 | 
| org.apache.pdfbox.pdmodel.graphics.color | 
 This package deals with colors that are stored in a PDF document. 
 | 
| org.apache.pdfbox.pdmodel.graphics.form | 
 This package deals with Form XObjects that are stored in a PDF document. 
 | 
| org.apache.pdfbox.pdmodel.graphics.image | 
 This package deals with images that are stored in a PDF document. 
 | 
| org.apache.pdfbox.pdmodel.interactive.action | 
 This package represents actions that can be performed in a PDF document. 
 | 
| org.apache.pdfbox.pdmodel.interactive.annotation | 
 The annotation package contains classes that work with PDF annotation elements. 
 | 
| org.apache.pdfbox.preflight.parser | |
| org.apache.pdfbox.preflight.process | |
| org.apache.pdfbox.preflight.utils | |
| org.apache.pdfbox.preflight.xobject | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
COSDocument.createCOSStream()
Creates a new COSStream using the current configuration for scratch files. 
 | 
COSStream | 
COSDocument.createCOSStream(COSDictionary dictionary)
Creates a new COSStream using the current configuration for scratch files. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Object | 
ICOSVisitor.visitFromStream(COSStream obj)
Notification of visit to stream object. 
 | 
| Constructor and Description | 
|---|
StreamPane(COSStream cosStream,
          boolean isContentStream,
          boolean isThumb,
          COSDictionary resourcesDic)
Constructor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
PDFXRefStream.getStream()
Returns the stream of the XRef. 
 | 
protected COSStream | 
COSParser.parseCOSStream(COSDictionary dic)
This will read a COSStream from the input stream using length attribute within dictionary. 
 | 
| Constructor and Description | 
|---|
PDFObjectStreamParser(COSStream stream,
                     COSDocument document)
Constructor. 
 | 
PDFStreamParser(COSStream stream)
Deprecated. 
 
Use  
PDFStreamParser.PDFStreamParser(PDContentStream) instead. | 
PDFXrefStreamParser(COSStream stream,
                   COSDocument document,
                   XrefTrailerResolver resolver)
Constructor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Object | 
COSWriter.visitFromStream(COSStream obj)  | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
PDStream.getCOSObject()
Get the cos stream associated with this object. 
 | 
COSStream | 
PDStream.getStream()
Deprecated. 
 
 | 
| Constructor and Description | 
|---|
PDMetadata(COSStream str)
Constructor. 
 | 
PDObjectStream(COSStream str)
Constructor. 
 | 
PDStream(COSStream str)
Creates a PDStream which wraps the given COSStream. 
 | 
| Constructor and Description | 
|---|
PDEmbeddedFile(COSStream str)
Constructor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
SecurityHandler.decryptStream(COSStream stream,
             long objNum,
             long genNum)
This will decrypt a stream. 
 | 
void | 
SecurityHandler.encryptStream(COSStream stream,
             long objNum,
             int genNum)
This will encrypt a stream, but not the dictionary as the dictionary is
 encrypted by visitFromString() in COSWriter and we don't want to encrypt
 it twice. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
FDFDictionary.getDifferences()
This will get the incremental updates since the PDF was last opened. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
FDFDictionary.setDifferences(COSStream diff)
This will set the differences stream. 
 | 
void | 
FDFField.setRichText(COSStream rv)
This will set the rich text value. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
PDType3CharProc.getCOSObject()  | 
| Constructor and Description | 
|---|
PDType3CharProc(PDType3Font font,
               COSStream charStream)  | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
PDXObject.getCOSObject()
Returns the stream. 
 | 
COSStream | 
PDXObject.getCOSStream()
Deprecated. 
 
 | 
| Constructor and Description | 
|---|
PDPostScriptXObject(COSStream stream)
Creates a PostScript XObject. 
 | 
PDXObject(COSStream stream,
         COSName subtype)
Creates a new XObject from the given stream and subtype. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
PDOutputIntent.getDestOutputIntent()  | 
COSStream | 
PDICCBased.getMetadata()
Returns the metadata stream for this object, or null if there is no metadata stream. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
PDICCBased.setMetadata(COSStream metadata)
Sets the metadata stream that is associated with this color space. 
 | 
| Constructor and Description | 
|---|
PDFormXObject(COSStream stream)
Creates a Form XObject for reading. 
 | 
PDFormXObject(COSStream stream,
             ResourceCache cache)
Creates a Form XObject for reading. 
 | 
PDTransparencyGroup(COSStream stream,
                   ResourceCache cache)
Creates a Transparency Group for reading. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static PDImageXObject | 
PDImageXObject.createThumbnail(COSStream cosStream)
Creates a thumbnail Image XObject from the given COSBase and name. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
COSStream | 
PDActionSound.getSound()
Gets the sound object. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
PDActionSound.setSound(COSStream sound)
Sets the sound object. 
 | 
| Constructor and Description | 
|---|
PDAppearanceStream(COSStream stream)
Creates a Form XObject for reading. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected COSStream | 
PreflightParser.parseCOSStream(COSDictionary dic)
Wraps the  
COSParser.parseCOSStream(org.apache.pdfbox.cos.COSDictionary) to check rules on 'stream' and 'endstream'
 keywords. | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
StreamValidationProcess.checkDictionaryEntries(PreflightContext context,
                      COSStream streamObj)
Check dictionary entries. 
 | 
protected void | 
StreamValidationProcess.checkFilters(COSStream stream,
            PreflightContext context)
This method checks if one of declared Filter is LZWdecode. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static COSStream | 
COSUtils.getAsStream(COSBase cbase,
           COSDocument cDoc)
Return the COSBase object as COSStream if the COSBase object is an instance of COSStream or a reference to a
 COSStream object. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected COSStream | 
AbstractXObjValidator.xobject
The XObject to validate as a COSStream. 
 | 
| Constructor and Description | 
|---|
AbstractXObjValidator(PreflightContext context,
                     COSStream xobj)  | 
Copyright © 2002–2018 The Apache Software Foundation. All rights reserved.