PDFTextStream (PDFxStream API Reference)

java.lang.Object
- com.snowtide.pdf.PDFTextStream

All Implemented Interfaces:

Document

Deprecated.
```
public class PDFTextStream
extends java.lang.Object
implements Document
```
This class is deprecated, and provided solely to ensure backwards compatibility for codebases written for the PDFTextStream v2.x API.
Please use the open methods on the PDF factory class for opening PDF documents, e.g. PDF.open(java.io.File).

Version:

©2004-2024 Snowtide

Field Summary
- Fields inherited from interface com.snowtide.pdf.Document
  ATTR_AUTHOR, ATTR_CREATION_DATE, ATTR_CREATOR, ATTR_KEYWORDS, ATTR_MOD_DATE, ATTR_PRODUCER, ATTR_SUBJECT, ATTR_TITLE, ATTR_TRAPPED, ATTR_USES_GRAPH_FONTS

Constructor Summary

Constructors
Constructor and Description
`PDFTextStream(java.nio.ByteBuffer pdfData, java.lang.String pdfName)` Deprecated.
`PDFTextStream(java.nio.ByteBuffer pdfData, java.lang.String pdfName, byte[] userPasswd)` Deprecated.
`PDFTextStream(java.nio.ByteBuffer pdfData, java.lang.String pdfName, byte[] userPasswd, Configuration config)` Deprecated.
`PDFTextStream(java.io.File pdfFile)` Deprecated.
`PDFTextStream(java.io.File pdfFile, byte[] userPasswd)` Deprecated.
`PDFTextStream(java.io.File pdfFile, byte[] userPasswd, Configuration config)` Deprecated.
`PDFTextStream(java.io.InputStream is, java.lang.String pdfName)` Deprecated.
`PDFTextStream(java.io.InputStream is, java.lang.String pdfName, byte[] userPasswd)` Deprecated.
`PDFTextStream(java.io.InputStream is, java.lang.String pdfName, byte[] userPasswd, Configuration config)` Deprecated.
`PDFTextStream(java.lang.String pdfFilePath)` Deprecated.
`PDFTextStream(java.lang.String pdfFilePath, byte[] userPasswd)` Deprecated.
`PDFTextStream(java.lang.String pdfFilePath, byte[] userPasswd, Configuration config)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Deprecated.
`java.util.List<Annotation>`	`getAllAnnotations()` Deprecated. Returns a list containing all of the `Annotation`s contained in the current PDF document.
`int`	`getAllAnnotations(java.util.List tgt)` Deprecated. Adds to the given List all of the `Annotation`s contained in the current PDF document.
`java.util.List<EmbeddedFile>`	`getAllEmbeddedFiles()` Deprecated. Returns a list of all of `the embedded files` available in the source PDF.
`java.util.List<Annotation>`	`getAnnotations(int page)` Deprecated. Returns a List of all annotations found on the page indicated by the given page number; each object will be an instance of a class that implements the `Annotation` interface.
`java.lang.Object`	`getAttribute(java.lang.String attrName)` Deprecated. Returns the value of the specified document-level metadata attribute.
`java.util.Set`	`getAttributeKeys()` Deprecated. Returns a `Set` containing the keys of all available document metadata attributes.
`java.util.Map`	`getAttributeMap()` Deprecated. Returns a `Map` containing a copy of all keys and values of all available document metadata attributes.
`Bookmark`	`getBookmarks()` Deprecated. If the current PDF document contains a bookmark tree, this function will return its root node.
`Configuration`	`getConfig()` Deprecated. Returns the `Configuration` instance that this `Document` is using to govern its operation.
`java.util.List<EmbeddedFile>`	`getEmbeddedFiles()` Deprecated. Returns a list of `the embedded files` associated with the source PDF document itself.
`EncryptionInfo`	`getEncryptionInfo()` Deprecated. Returns an EncryptionInfo object, which provides access to some of the parameters used for the current PDF document's encryption.
`Form`	`getFormData()` Deprecated. Loads the form data contained in the current document, and returns a `Form` object that represents that data.
`java.util.Collection<Image>`	`getImages()` Deprecated. Returns a collection of all of the `Image`s in this `Document`.
`java.lang.String`	`getName()` Deprecated. Returns the name of the PDF that this `Document` is reading; this will be either the name of the PDF file that is being read, or the `pdfName` String that was provided if this `Document` was opened using one of the `com.snowtide.PDF.open()` methods that accepts an `InputStream` or `ByteBuffer`, e.g.
`Page`	`getPage(int n)` Deprecated. Reads and returns a single page.
`int`	`getPageCnt()` Deprecated. Returns the number of pages in the PDF document.
`java.util.List<Page>`	`getPages()` Deprecated. Returns a list of `pages` from this `Document`, which are loaded lazily when accessed via the returned list.
`java.io.File`	`getPDFFile()` Deprecated. Returns a reference to the file that this `Document` is processing.
`long`	`getPdfFileSize()` Deprecated. Returns the size of the PDF file being read, in bytes.
`PDFVersion`	`getPDFVersion()` Deprecated. Returns the `PDFVersion` instance that corresponds with the version of the PDF file specification to which current PDF file adheres.
`byte[]`	`getXmlMetadata()` Deprecated. Returns the XML metadata available from this `Document`, or null if no XML metadata is available.
`static boolean`	`isLicensed()` Deprecated. Retained to maintain PDFTextStream v2.x API compatibility. Use `()` instead.
`static boolean`	`loadLicense(java.lang.String path)` Deprecated. Retained to maintain PDFTextStream v2.x API compatibility. Use `(String)` instead.
`static boolean`	`loadLicense(java.net.URL licenseLocation)` Deprecated. Retained to maintain PDFTextStream v2.x API compatibility. Use `PDF.loadLicense(java.net.URL)` instead.
`void`	`pipe(OutputHandler handler)` Deprecated. Extracts all available text from this `Document`, sending all PDF text events to the given `OutputHandler`.
`void`	`setConfig(Configuration config)` Deprecated. Sets the `Configuration` instance that this `Document` will use in various contexts to govern its operation.

- Constructor Detail
  - PDFTextStream
```
public PDFTextStream(java.io.InputStream is,
                     java.lang.String pdfName)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.io.File pdfFile)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.lang.String pdfFilePath)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.io.InputStream is,
                     java.lang.String pdfName,
                     byte[] userPasswd,
                     Configuration config)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.io.InputStream is,
                     java.lang.String pdfName,
                     byte[] userPasswd)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.io.File pdfFile,
                     byte[] userPasswd,
                     Configuration config)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.lang.String pdfFilePath,
                     byte[] userPasswd,
                     Configuration config)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.io.File pdfFile,
                     byte[] userPasswd)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.lang.String pdfFilePath,
                     byte[] userPasswd)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.nio.ByteBuffer pdfData,
                     java.lang.String pdfName,
                     byte[] userPasswd,
                     Configuration config)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.nio.ByteBuffer pdfData,
                     java.lang.String pdfName,
                     byte[] userPasswd)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
  - PDFTextStream
```
public PDFTextStream(java.nio.ByteBuffer pdfData,
                     java.lang.String pdfName)
```
    Deprecated.
    
    Equivalent to the corresponding "open" static method in PDF, provided to ensure backwards compatibility with codebases using the PDFTextStream v2.x API.
- Method Detail
  - loadLicense
```
public static boolean loadLicense(java.lang.String path)
```
    Deprecated. Retained to maintain PDFTextStream v2.x API compatibility. Use (String) instead.
  - loadLicense
```
public static boolean loadLicense(java.net.URL licenseLocation)
```
    Deprecated. Retained to maintain PDFTextStream v2.x API compatibility. Use PDF.loadLicense(java.net.URL) instead.
  - isLicensed
```
public static boolean isLicensed()
```
    Deprecated. Retained to maintain PDFTextStream v2.x API compatibility. Use () instead.
  - setConfig
```
public void setConfig(Configuration config)
```
    Deprecated.
    
    Description copied from interface: Document
    
    Sets the Configuration instance that this Document will use in various contexts to govern its operation.
    Note that certain configuration options are utilized only when a Document is being opened. In order for non-default settings for those such options to take effect, a customized Configuration object must either be set as the default configuration, or must be provided to any of the com.snowtide.PDF.open() static methods that accept a Configuration object, e.g. PDF.open(java.io.File, byte[], Configuration).
    
    Specified by:
    
    setConfig in interface Document
  - getConfig
```
public Configuration getConfig()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns the Configuration instance that this Document is using to govern its operation.
    
    Specified by:
    
    getConfig in interface Document
  - pipe
```
public void pipe(OutputHandler handler)
```
    Deprecated.
    
    Description copied from interface: Document
    
    Extracts all available text from this Document, sending all PDF text events to the given OutputHandler.
    
    If no special PDF text event handling is needed (i.e. you just want a straight text extract), then using an OutputTarget is recommended.
    
    Specified by:
    
    pipe in interface Document
    
    Parameters:
    
    handler - an OutputHandler instance.
    
    See Also:
    
    OutputHandler, OutputTarget
  - getImages
```
public java.util.Collection<Image> getImages()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a collection of all of the Images in this Document.
    
    Specified by:
    
    getImages in interface Document
  - getPdfFileSize
```
public long getPdfFileSize()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns the size of the PDF file being read, in bytes.
    
    Specified by:
    
    getPdfFileSize in interface Document
  - getPageCnt
```
public int getPageCnt()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns the number of pages in the PDF document.
    
    Specified by:
    
    getPageCnt in interface Document
  - getPage
```
public Page getPage(int n)
```
    Deprecated.
    
    Description copied from interface: Document
    
    Reads and returns a single page. Page numbers are zero-indexed; they do not necessarily correspond with any reader-visible page number.
    
    Specified by:
    
    getPage in interface Document
    
    Parameters:
    
    n - the number of the page to retrieve.
  - getName
```
public java.lang.String getName()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns the name of the PDF that this Document is reading; this will be either the name of the PDF file that is being read, or the pdfName String that was provided if this Document was opened using one of the com.snowtide.PDF.open() methods that accepts an InputStream or ByteBuffer, e.g. PDF.open(java.io.InputStream, String)
    Nearly all of the logging messages generated by PDFxStream include the relevant Document's name, making them easier to interpret in a multithreaded production environment.
    
    Specified by:
    
    getName in interface Document
  - getPDFFile
```
public java.io.File getPDFFile()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a reference to the file that this Document is processing. This reference may be null if the Document instance is not reading from a File or InputStream.
    
    Specified by:
    
    getPDFFile in interface Document
  - close
```
public void close()
```
    Deprecated.
  - getFormData
```
public Form getFormData()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Loads the form data contained in the current document, and returns a Form object that represents that data. If the current PDF contains no forms, this function returns null. The Form instance that is returned by this function is guaranteed to be an AcroForm.
    This function MUST NOT be called after this Document is closed.
    
    Specified by:
    
    getFormData in interface Document
  - getEmbeddedFiles
```
public java.util.List<EmbeddedFile> getEmbeddedFiles()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a list of the embedded files associated with the source PDF document itself. Use Document.getAllEmbeddedFiles() to include all embedded files associated with annotations as well.
    
    Specified by:
    
    getEmbeddedFiles in interface Document
    
    See Also:
    
    Document.getAllEmbeddedFiles()
  - getAllEmbeddedFiles
```
public java.util.List<EmbeddedFile> getAllEmbeddedFiles()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a list of all of the embedded files available in the source PDF. This method includes all files associated with annotations as well; if you only want those embedded files that are associated with the source document itself (and not annotations), use Document.getEmbeddedFiles().
    
    Specified by:
    
    getAllEmbeddedFiles in interface Document
    
    See Also:
    
    Document.getEmbeddedFiles()
  - getBookmarks
```
public Bookmark getBookmarks()
```
    Deprecated.
    
    Description copied from interface: Document
    
    If the current PDF document contains a bookmark tree, this function will return its root node. If the document contains no bookmarks, this function will return null.
    An exception will be thrown if this function is called after this Document instance is closed.
    
    Specified by:
    
    getBookmarks in interface Document
    
    See Also:
    
    Bookmark
  - getAnnotations
```
public java.util.List<Annotation> getAnnotations(int page)
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a List of all annotations found on the page indicated by the given page number; each object will be an instance of a class that implements the Annotation interface.
    This function will never return null; if a page contains no annotations, an empty list will be returned. The returned list is guaranteed to offer efficient random access to its elements.
    
    Specified by:
    
    getAnnotations in interface Document
    
    See Also:
    
    Annotation
  - getAllAnnotations
```
public java.util.List<Annotation> getAllAnnotations()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a list containing all of the Annotations contained in the current PDF document. The returned list is guaranteed to offer efficient random access to its elements.
    
    Specified by:
    
    getAllAnnotations in interface Document
  - getAllAnnotations
```
public int getAllAnnotations(java.util.List tgt)
```
    Deprecated.
    
    Description copied from interface: Document
    
    Adds to the given List all of the Annotations contained in the current PDF document.
    
    Specified by:
    
    getAllAnnotations in interface Document
    
    Returns:
    
    the number of annotations added to the list
    
    See Also:
    
    Annotation
  - getPDFVersion
```
public PDFVersion getPDFVersion()
```
    Deprecated.
    
    Description copied from interface: Document
    Returns the PDFVersion instance that corresponds with the version of the PDF file specification to which current PDF file adheres. PDF specification version numbers correspond directly with particular versions of Adobe Acrobat:
    - v1.0 - Acrobat 1
    - v1.1 - Acrobat 2
    - v1.2 - Acrobat 3
    - v1.3 - Acrobat 4
    - v1.4 - Acrobat 5
    - v1.5 - Acrobat 6
    - v1.6 - Acrobat 7
    - v1.7 - Acrobat 8+
    This method may not be called after the Document is closed.
    Specified by:
    
    getPDFVersion in interface Document
  - getEncryptionInfo
```
public EncryptionInfo getEncryptionInfo()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns an EncryptionInfo object, which provides access to some of the parameters used for the current PDF document's encryption.
    If the current PDF document is not encrypted, this method will return null.
    
    Specified by:
    
    getEncryptionInfo in interface Document
  - getXmlMetadata
```
public byte[] getXmlMetadata()
```
    Deprecated.
    
    Description copied from interface: Document
    Returns the XML metadata available from this Document, or null if no XML metadata is available.
    
    Note: This method must be called before the Document is closed, and it should not be called while text is being actively read out of it. (Supporting such concurrency would require synchronization that would negatively impact performance.) Therefore, the best times to call this method are:
    - just after opening the Document but before reading text out of it
    - after all text has been read out of the Document, but before it is closed
    PDFxStream does not control the content returned by this method -- it just provides access to the data that is already stored in a PDF document. The schema of the the returned XML data is defined by Adobe, and is called the Extensible Metadata Platform (XMP). More information about XMP can be found on Adobe's website
    Specified by:
    
    getXmlMetadata in interface Document
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String attrName)
```
    Deprecated.
    
    Description copied from interface: Document
    Returns the value of the specified document-level metadata attribute.
    All of the standard attribute names are defined in constants in this class, and are all prefixed with 'ATTR_'. A few notes should be kept in mind when accessing attribute values:
    - It is typical for only a subset of the possible attributes to be defined in a PDF document. Any attributes that are undefined will return a null value when their name is provided to this method.
    - Many more attributes are used in the real world than are formally specified by the PDF specification. It is entirely up to the PDF generator what attributes are to be outputted for a particular document, so some documents may contain attributes whose names are not canonicalized in the 'ATTR_' constants in this class. You can use the getAttributeKeys() method to get a Set of the names of all available attributes.
    - Most attribute values are Strings, but it is possible for attribute values to be Integers, Booleans, etc. The documentation associated with each attribute name constant in this class specifies what type may be expected when retrieving each particular attribute value. Any attributes specified as dates are returned from this method as String instances; these can be passed through parseDateString(String) to get a Date object.
    Note: the attributes available through this method are retrieved from the "classic" document /Info entry. The document metadata in an XML format (which typically contains the same set of metadata attributes that are available through this method) may be obtained via the getXmlMetadata() method.
    Specified by:
    
    getAttribute in interface Document
    
    Parameters:
    
    attrName - the name of the attribute to be retrieved
    
    Returns:
    
    the value of the attribute with the given name defined in the PDF document being read, or null if no attribute is available with the given name. The type of this object depends upon which attribute is being retrieved, and is noted in the documentation of the attribute name constants held by this class.
    
    See Also:
    
    getXmlMetadata() for access to the XML-formatted document metadata
  - getAttributeKeys
```
public java.util.Set getAttributeKeys()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a Set containing the keys of all available document metadata attributes.
    
    Specified by:
    
    getAttributeKeys in interface Document
  - getAttributeMap
```
public java.util.Map getAttributeMap()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a Map containing a copy of all keys and values of all available document metadata attributes.
    
    Specified by:
    
    getAttributeMap in interface Document
  - getPages
```
public java.util.List<Page> getPages()
```
    Deprecated.
    
    Description copied from interface: Document
    
    Returns a list of pages from this Document, which are loaded lazily when accessed via the returned list.
    
    Specified by:
    
    getPages in interface Document

Class PDFTextStream

Field Summary

Fields inherited from interface com.snowtide.pdf.Document

Constructor Summary

Method Summary

Constructor Detail

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

PDFTextStream

Method Detail

loadLicense

loadLicense

isLicensed

setConfig

getConfig

pipe

getImages

getPdfFileSize

getPageCnt

getPage

getName

getPDFFile

close

getFormData

getEmbeddedFiles

getAllEmbeddedFiles

getBookmarks

getAnnotations

getAllAnnotations

getAllAnnotations

getPDFVersion

getEncryptionInfo

getXmlMetadata

getAttribute

getAttributeKeys

getAttributeMap

getPages