org.apache.pdfbox

Class Loader

java.lang.Object

org.apache.pdfbox.Loader

public class Loader
extends Object

Utility methods to load different types of documents

Method Summary

Modifier and Type	Method and Description
static FDFDocument	loadFDF(File file) This will load a document from a file.
static FDFDocument	loadFDF(InputStream input) This will load a document from an input stream.
static FDFDocument	loadFDF(String filename) This will load a document from a file.
static PDDocument	loadPDF(byte[] input) Parses a PDF.
static PDDocument	loadPDF(byte[] input, String password) Parses a PDF.
static PDDocument	loadPDF(byte[] input, String password, InputStream keyStore, String alias) Parses a PDF.
static PDDocument	loadPDF(byte[] input, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Parses a PDF.
static PDDocument	loadPDF(File file) Parses a PDF.
static PDDocument	loadPDF(File file, MemoryUsageSetting memUsageSetting) Parses a PDF.
static PDDocument	loadPDF(File file, String password) Parses a PDF.
static PDDocument	loadPDF(File file, String password, InputStream keyStore, String alias) Parses a PDF.
static PDDocument	loadPDF(File file, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Parses a PDF.
static PDDocument	loadPDF(File file, String password, MemoryUsageSetting memUsageSetting) Parses a PDF.
static PDDocument	loadPDF(InputStream input) Parses a PDF.
static PDDocument	loadPDF(InputStream input, MemoryUsageSetting memUsageSetting) Parses a PDF.
static PDDocument	loadPDF(InputStream input, String password) Parses a PDF.
static PDDocument	loadPDF(InputStream input, String password, InputStream keyStore, String alias) Parses a PDF.
static PDDocument	loadPDF(InputStream input, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Parses a PDF.
static PDDocument	loadPDF(InputStream input, String password, MemoryUsageSetting memUsageSetting) Parses a PDF.
static PDDocument	loadPDF(RandomAccessRead raFile, String password, InputStream keyStore, String alias, MemoryUsageSetting memUsageSetting) Parses a PDF.
static FDFDocument	loadXFDF(File file) This will load a document from a file.
static FDFDocument	loadXFDF(InputStream input) This will load a document from an input stream.
static FDFDocument	loadXFDF(String filename) This will load a document from a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadFDF

public static FDFDocument loadFDF(String filename)
                           throws IOException

This will load a document from a file.

Parameters:

filename - The name of the file to load.

Returns:

The document that was loaded.

Throws:

IOException - If there is an error reading from the stream.

loadFDF

public static FDFDocument loadFDF(File file)
                           throws IOException

This will load a document from a file.

Parameters:

file - The name of the file to load.

Returns:

The document that was loaded.

Throws:

IOException - If there is an error reading from the stream.

loadFDF

public static FDFDocument loadFDF(InputStream input)
                           throws IOException

This will load a document from an input stream.

Parameters:

input - The stream that contains the document.

Returns:

The document that was loaded.

Throws:

IOException - If there is an error reading from the stream.

loadXFDF

public static FDFDocument loadXFDF(String filename)
                            throws IOException

This will load a document from a file.

Parameters:

filename - The name of the file to load.

Returns:

The document that was loaded.

Throws:

IOException - If there is an error reading from the stream.

loadXFDF

public static FDFDocument loadXFDF(File file)
                            throws IOException

This will load a document from a file.

Parameters:

file - The name of the file to load.

Returns:

The document that was loaded.

Throws:

IOException - If there is an error reading from the stream.

loadXFDF

public static FDFDocument loadXFDF(InputStream input)
                            throws IOException

This will load a document from an input stream.

Parameters:

input - The stream that contains the document.

Returns:

The document that was loaded.

Throws:

IOException - If there is an error reading from the stream.

loadPDF

public static PDDocument loadPDF(byte[] input)
                          throws IOException

Parses a PDF. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

input - byte array that contains the document.

Returns:

loaded document

Throws:

InvalidPasswordException - If the PDF required a non-empty password.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(byte[] input,
                                 String password)
                          throws IOException

Parses a PDF. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

input - byte array that contains the document.

password - password to be used for decryption

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(byte[] input,
                                 String password,
                                 InputStream keyStore,
                                 String alias)
                          throws IOException

Parses a PDF. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

input - byte array that contains the document.

password - password to be used for decryption

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(byte[] input,
                                 String password,
                                 InputStream keyStore,
                                 String alias,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF.

Parameters:

input - byte array that contains the document.

password - password to be used for decryption

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

memUsageSetting - defines how memory is used for buffering input stream and PDF streams

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(File file)
                          throws IOException

Parses a PDF. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

file - file to be loaded

Returns:

loaded document

Throws:

InvalidPasswordException - If the file required a non-empty password.

IOException - in case of a file reading or parsing error

loadPDF

public static PDDocument loadPDF(File file,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF.

Parameters:

file - file to be loaded

memUsageSetting - defines how memory is used for buffering PDF streams

Returns:

loaded document

Throws:

InvalidPasswordException - If the file required a non-empty password.

IOException - in case of a file reading or parsing error

loadPDF

public static PDDocument loadPDF(File file,
                                 String password)
                          throws IOException

Parses a PDF. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

file - file to be loaded

password - password to be used for decryption

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - in case of a file reading or parsing error

loadPDF

public static PDDocument loadPDF(File file,
                                 String password,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF.

Parameters:

file - file to be loaded

password - password to be used for decryption

memUsageSetting - defines how memory is used for buffering PDF streams

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - in case of a file reading or parsing error

loadPDF

public static PDDocument loadPDF(File file,
                                 String password,
                                 InputStream keyStore,
                                 String alias)
                          throws IOException

Parses a PDF. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

file - file to be loaded

password - password to be used for decryption

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

Returns:

loaded document

Throws:

IOException - in case of a file reading or parsing error

loadPDF

public static PDDocument loadPDF(File file,
                                 String password,
                                 InputStream keyStore,
                                 String alias,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF.

Parameters:

file - file to be loaded

password - password to be used for decryption

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

memUsageSetting - defines how memory is used for buffering PDF streams

Returns:

loaded document

Throws:

IOException - in case of a file reading or parsing error

loadPDF

public static PDDocument loadPDF(RandomAccessRead raFile,
                                 String password,
                                 InputStream keyStore,
                                 String alias,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF.

Parameters:

raFile - random access read representing the pdf to be loaded

password - password to be used for decryption

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

memUsageSetting - defines how memory is used PDF streams

Returns:

loaded document

Throws:

IOException - in case of a file reading or parsing error

loadPDF

public static PDDocument loadPDF(InputStream input)
                          throws IOException

Parses a PDF. The given input stream is copied to the memory to enable random access to the pdf. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

input - stream that contains the document. Don't forget to close it after loading.

Returns:

loaded document

Throws:

InvalidPasswordException - If the PDF required a non-empty password.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(InputStream input,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF. Depending on the memory settings parameter the given input stream is either copied to main memory or to a temporary file to enable random access to the pdf.

Parameters:

input - stream that contains the document. Don't forget to close it after loading.

memUsageSetting - defines how memory is used for buffering PDF streams

Returns:

loaded document

Throws:

InvalidPasswordException - If the PDF required a non-empty password.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(InputStream input,
                                 String password)
                          throws IOException

Parses a PDF. The given input stream is copied to the memory to enable random access to the pdf. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

input - stream that contains the document. Don't forget to close it after loading.

password - password to be used for decryption

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(InputStream input,
                                 String password,
                                 InputStream keyStore,
                                 String alias)
                          throws IOException

Parses a PDF. The given input stream is copied to the memory to enable random access to the pdf. Unrestricted main memory will be used for buffering PDF streams.

Parameters:

input - stream that contains the document. Don't forget to close it after loading.

password - password to be used for decryption

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

Returns:

loaded document

Throws:

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(InputStream input,
                                 String password,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF. Depending on the memory settings parameter the given input stream is either copied to main memory or to a temporary file to enable random access to the pdf.

Parameters:

input - stream that contains the document. Don't forget to close it after loading.

password - password to be used for decryption

memUsageSetting - defines how memory is used for buffering PDF streams

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - In case of a reading or parsing error.

loadPDF

public static PDDocument loadPDF(InputStream input,
                                 String password,
                                 InputStream keyStore,
                                 String alias,
                                 MemoryUsageSetting memUsageSetting)
                          throws IOException

Parses a PDF. The given input stream is copied to memory to enable random access to the pdf.

Parameters:

input - stream that contains the document. Don't forget to close it after loading.

password - password to be used for decryption

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

memUsageSetting - defines how memory is used for buffering PDF streams

Returns:

loaded document

Throws:

InvalidPasswordException - If the password is incorrect.

IOException - In case of a reading or parsing error.