A C G I L M O P R S T U W

A

available() - Method in class org.apache.pdfbox.io.RandomAccessInputStream

available() - Method in interface org.apache.pdfbox.io.RandomAccessRead

Returns an estimate of the number of bytes that can be read.

C

clear() - Method in interface org.apache.pdfbox.io.RandomAccessWrite

Clears all data of the buffer.

close() - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

close() - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

close() - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

close() - Method in class org.apache.pdfbox.io.RandomAccessReadView

close() - Method in class org.apache.pdfbox.io.ScratchFile

Closes and deletes the temporary file.

close() - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

closeAndLogException(Closeable, Log, String, IOException) - Static method in class org.apache.pdfbox.io.IOUtils

Try to close an IO resource and log and return if there was an exception.

closeQuietly(Closeable) - Static method in class org.apache.pdfbox.io.IOUtils

Null safe close of the given Closeable suppressing any exception.

copy(InputStream, OutputStream) - Static method in class org.apache.pdfbox.io.IOUtils

Copies all the contents from the given input stream to the given output stream.

create() - Method in interface org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction

Creates an instance of a RandomAccessStreamCache.

createBuffer() - Method in interface org.apache.pdfbox.io.RandomAccessStreamCache

Creates an instance of a buffer implementing the interface org.apache.pdfbox.io.RandomAccess.

createBuffer() - Method in class org.apache.pdfbox.io.ScratchFile

Creates a new buffer using this page handler.

createBufferFromStream(InputStream) - Static method in class org.apache.pdfbox.io.RandomAccessReadBuffer

Create e new RandomAccessReadBuffer using the given InputStream.

createMemoryOnlyStreamCache() - Static method in class org.apache.pdfbox.io.IOUtils

Provides a function to create an instance of a memory only StreamCache using unrestricted main memory.

createTempFileOnlyStreamCache() - Static method in class org.apache.pdfbox.io.IOUtils

Provides a function to create an instance of a temp file only StreamCache using unrestricted size.

createView(long, long) - Method in interface org.apache.pdfbox.io.RandomAccessRead

Creates a random access read view starting at the given position with the given length.

createView(long, long) - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

createView(long, long) - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

createView(long, long) - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

createView(long, long) - Method in class org.apache.pdfbox.io.RandomAccessReadView

createView(long, long) - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

G

getMainMemoryOnlyInstance() - Static method in class org.apache.pdfbox.io.ScratchFile

Getter for an instance using only unrestricted main memory for buffering (same as new ScratchFile(MemoryUsageSetting.setupMainMemoryOnly())).

getMainMemoryOnlyInstance(long) - Static method in class org.apache.pdfbox.io.ScratchFile

Getter for an instance to only use main-memory with the defined maximum.

getMaxMainMemoryBytes() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Returns maximum size of main-memory in bytes to be used.

getMaxStorageBytes() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Returns maximum size of storage bytes to be used (main-memory in temporary files all together).

getPosition() - Method in interface org.apache.pdfbox.io.RandomAccessRead

Returns offset of next byte to be returned by a read method.

getPosition() - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

Returns offset of next byte to be returned by a read method.

getPosition() - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

getPosition() - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

Returns offset of next byte to be returned by a read method.

getPosition() - Method in class org.apache.pdfbox.io.RandomAccessReadView

Returns offset of next byte to be returned by a read method.

getPosition() - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

getTempDir() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Returns directory to be used for temporary files or null if it was not set.

I

IOUtils - Class in org.apache.pdfbox.io

This class contains various I/O-related methods.

isClosed() - Method in interface org.apache.pdfbox.io.RandomAccessRead

Returns true if this source has been closed.

isClosed() - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

Returns true if this source has been closed.

isClosed() - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

isClosed() - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

Returns true if this source has been closed.

isClosed() - Method in class org.apache.pdfbox.io.RandomAccessReadView

Returns true if this source has been closed.

isClosed() - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

isEOF() - Method in interface org.apache.pdfbox.io.RandomAccessRead

A simple test to see if we are at the end of the data.

isEOF() - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

A simple test to see if we are at the end of the data.

isEOF() - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

isEOF() - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

A simple test to see if we are at the end of the data.

isEOF() - Method in class org.apache.pdfbox.io.RandomAccessReadView

A simple test to see if we are at the end of the data.

isEOF() - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

isMainMemoryRestricted() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Returns true if maximum main memory is restricted to a specific number of bytes.

isStorageRestricted() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Returns true if maximum amount of storage is restricted to a specific number of bytes.

L

length() - Method in interface org.apache.pdfbox.io.RandomAccessRead

The total number of bytes that are available.

length() - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

The total number of bytes that are available.

length() - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

length() - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

The total number of bytes that are available.

length() - Method in class org.apache.pdfbox.io.RandomAccessReadView

The total number of bytes that are available.

length() - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

M

MemoryUsageSetting - Class in org.apache.pdfbox.io

Controls how memory/temporary files are used for buffering streams etc.

O

org.apache.pdfbox.io - package org.apache.pdfbox.io

This package contains IO streams.

P

peek() - Method in interface org.apache.pdfbox.io.RandomAccessRead

This will peek at the next byte.

populateBuffer(InputStream, byte[]) - Static method in class org.apache.pdfbox.io.IOUtils

Populates the given buffer with data read from the input stream.

R

RandomAccess - Interface in org.apache.pdfbox.io

An interface to allow data to be stored completely in memory or to use a scratch file on the disk.

RandomAccessInputStream - Class in org.apache.pdfbox.io

An InputStream which reads from a RandomAccessRead.

RandomAccessInputStream(RandomAccessRead) - Constructor for class org.apache.pdfbox.io.RandomAccessInputStream

Creates a new RandomAccessInputStream, with a position of zero.

RandomAccessOutputStream - Class in org.apache.pdfbox.io

An OutputStream which writes to a RandomAccessWrite.

RandomAccessOutputStream(RandomAccessWrite) - Constructor for class org.apache.pdfbox.io.RandomAccessOutputStream

Constructor to create a new output stream which writes to the given RandomAccessWrite.

RandomAccessRead - Interface in org.apache.pdfbox.io

An interface allowing random access read operations.

RandomAccessReadBuffer - Class in org.apache.pdfbox.io

An implementation of the RandomAccessRead interface to store data in memory.

RandomAccessReadBuffer(byte[]) - Constructor for class org.apache.pdfbox.io.RandomAccessReadBuffer

Create a random access buffer using the given byte array.

RandomAccessReadBuffer(ByteBuffer) - Constructor for class org.apache.pdfbox.io.RandomAccessReadBuffer

Create a random access buffer using the given ByteBuffer.

RandomAccessReadBuffer(InputStream) - Constructor for class org.apache.pdfbox.io.RandomAccessReadBuffer

Create a random access read buffer of the given input stream by copying the data to the memory.

RandomAccessReadBufferedFile - Class in org.apache.pdfbox.io

Provides random access to portions of a file combined with buffered reading of content.

RandomAccessReadBufferedFile(String) - Constructor for class org.apache.pdfbox.io.RandomAccessReadBufferedFile

Create a random access buffered file instance for the file with the given name.

RandomAccessReadBufferedFile(File) - Constructor for class org.apache.pdfbox.io.RandomAccessReadBufferedFile

Create a random access buffered file instance for the given file.

RandomAccessReadMemoryMappedFile - Class in org.apache.pdfbox.io

An implementation of the RandomAccess interface backed by a memory mapped file channel.

RandomAccessReadMemoryMappedFile(String) - Constructor for class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

Default constructor.

RandomAccessReadMemoryMappedFile(File) - Constructor for class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

Default constructor.

RandomAccessReadView - Class in org.apache.pdfbox.io

This class provides a view of a part of a random access read.

RandomAccessReadView(RandomAccessRead, long, long) - Constructor for class org.apache.pdfbox.io.RandomAccessReadView

Constructor.

RandomAccessReadView(RandomAccessRead, long, long, boolean) - Constructor for class org.apache.pdfbox.io.RandomAccessReadView

Constructor.

RandomAccessStreamCache - Interface in org.apache.pdfbox.io

An interface describing a StreamCache to be used when creating/writing streams of a PDF.

RandomAccessStreamCache.StreamCacheCreateFunction - Interface in org.apache.pdfbox.io

RandomAccessWrite - Interface in org.apache.pdfbox.io

An interface allowing random access write operations.

read() - Method in class org.apache.pdfbox.io.RandomAccessInputStream

read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessInputStream

read() - Method in interface org.apache.pdfbox.io.RandomAccessRead

Read a single byte of data.

read(byte[]) - Method in interface org.apache.pdfbox.io.RandomAccessRead

Read a buffer of data.

read(byte[], int, int) - Method in interface org.apache.pdfbox.io.RandomAccessRead

Read a buffer of data.

read() - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

Read a single byte of data.

read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

Read a buffer of data.

read() - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

read() - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

Read a single byte of data.

read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

Read a buffer of data.

read() - Method in class org.apache.pdfbox.io.RandomAccessReadView

Read a single byte of data.

read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessReadView

Read a buffer of data.

read() - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

read(byte[], int, int) - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

rewind(int) - Method in interface org.apache.pdfbox.io.RandomAccessRead

Seek backwards the given number of bytes.

rewind(int) - Method in class org.apache.pdfbox.io.RandomAccessReadView

Seek backwards the given number of bytes.

S

ScratchFile - Class in org.apache.pdfbox.io

Implements a memory page handling mechanism as base for creating (multiple) RandomAccess buffers each having its set of pages (implemented by ScratchFileBuffer).

ScratchFile(File) - Constructor for class org.apache.pdfbox.io.ScratchFile

Initializes page handler.

ScratchFile(MemoryUsageSetting) - Constructor for class org.apache.pdfbox.io.ScratchFile

Initializes page handler.

seek(long) - Method in interface org.apache.pdfbox.io.RandomAccessRead

Seek to a position in the data.

seek(long) - Method in class org.apache.pdfbox.io.RandomAccessReadBuffer

Seek to a position in the data.

seek(long) - Method in class org.apache.pdfbox.io.RandomAccessReadBufferedFile

Seeks to new position.

seek(long) - Method in class org.apache.pdfbox.io.RandomAccessReadMemoryMappedFile

Seek to a position in the data.

seek(long) - Method in class org.apache.pdfbox.io.RandomAccessReadView

Seek to a position in the data.

seek(long) - Method in class org.apache.pdfbox.io.SequenceRandomAccessRead

SequenceRandomAccessRead - Class in org.apache.pdfbox.io

Wrapper class to combine several RandomAccessRead instances so that they can be accessed as one big RandomAccessRead.

SequenceRandomAccessRead(List<RandomAccessRead>) - Constructor for class org.apache.pdfbox.io.SequenceRandomAccessRead

setTempDir(File) - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Sets directory to be used for temporary files.

setupMainMemoryOnly() - Static method in class org.apache.pdfbox.io.MemoryUsageSetting

Setups buffering memory usage to only use main-memory (no temporary file) which is not restricted in size.

setupMainMemoryOnly(long) - Static method in class org.apache.pdfbox.io.MemoryUsageSetting

Setups buffering memory usage to only use main-memory with the defined maximum.

setupMixed(long) - Static method in class org.apache.pdfbox.io.MemoryUsageSetting

Setups buffering memory usage to use a portion of main-memory and additionally temporary file(s) in case the specified portion is exceeded.

setupMixed(long, long) - Static method in class org.apache.pdfbox.io.MemoryUsageSetting

Setups buffering memory usage to use a portion of main-memory and additionally temporary file(s) in case the specified portion is exceeded.

setupTempFileOnly() - Static method in class org.apache.pdfbox.io.MemoryUsageSetting

Setups buffering memory usage to only use temporary file(s) (no main-memory) with not restricted size.

setupTempFileOnly(long) - Static method in class org.apache.pdfbox.io.MemoryUsageSetting

Setups buffering memory usage to only use temporary file(s) (no main-memory) with the specified maximum size.

skip(long) - Method in class org.apache.pdfbox.io.RandomAccessInputStream

skip(int) - Method in interface org.apache.pdfbox.io.RandomAccessRead

Skips a given number of bytes.

streamCache - Variable in class org.apache.pdfbox.io.MemoryUsageSetting

Implementation of the function to create an instance of ScratchFile using the current settings.

T

toByteArray(InputStream) - Static method in class org.apache.pdfbox.io.IOUtils

Reads the input stream and returns its contents as a byte array.

toString() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

U

unmap(ByteBuffer) - Static method in class org.apache.pdfbox.io.IOUtils

Unmap memory mapped byte buffers.

useMainMemory() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Returns true if main-memory is to be used.

useTempFile() - Method in class org.apache.pdfbox.io.MemoryUsageSetting

Returns true if temporary file is to be used.

W

write(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessOutputStream

write(byte[]) - Method in class org.apache.pdfbox.io.RandomAccessOutputStream

write(int) - Method in class org.apache.pdfbox.io.RandomAccessOutputStream

write(int) - Method in interface org.apache.pdfbox.io.RandomAccessWrite

Write a byte to the stream.

write(byte[]) - Method in interface org.apache.pdfbox.io.RandomAccessWrite

Write a buffer of data to the stream.

write(byte[], int, int) - Method in interface org.apache.pdfbox.io.RandomAccessWrite

Write a buffer of data to the stream.

A C G I L M O P R S T U W