com.qoppa.pdf.source

Interface PDFSource

All Known Implementing Classes:

ByteArrayPDFSource, EmptyPDFSource, FilePDFSource, InputStreamPDFSource, MBBPDFSource, RAFilePDFSource, URLOnDemandPDFSource, URLPDFSource

public interface PDFSource

Represents a source of PDF content. This interface is used to provide PDF content to the library when loading a document. There are a number of default implementations in this package to load PDF documents from files, byte arrays, input streams and URLs. A host application can also create its own implementation if the source of the PDF content is custom.

Author:

Qoppa Software

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(PDFSource other) Tests if this source is equal to another source.
PDFContent	getContent() Returns an object that implements PDFContent, that contains and can deliver the contents of the PDF document.
String	getName() Returns the name of the document.
String	getPath() Returns the full path to the document.

Method Detail

getName

String getName()

Returns the name of the document. The name of the document is normally the file name.

getPath

String getPath()

Returns the full path to the document. The path of the document should normally be sufficient to uniquely identify the document. If the source is a file, the path is the full path to the file.

equals

boolean equals(PDFSource other)

Tests if this source is equal to another source.

getContent

PDFContent getContent()
                      throws IOException

Returns an object that implements PDFContent, that contains and can deliver the contents of the PDF document.

Returns:

Returns an object that implements the PDFContent interface.

Throws:

IOException