com.itextpdf.io.source

Class RandomAccessSourceFactory

java.lang.Object

com.itextpdf.io.source.RandomAccessSourceFactory

public final class RandomAccessSourceFactory
extends Object

Factory to create IRandomAccessSource objects based on various types of sources

Constructor Summary

Constructors

Constructor and Description
RandomAccessSourceFactory() Creates a factory that will give preference to accessing the underling data source using memory mapped files

Method Summary

Modifier and Type	Method and Description
IRandomAccessSource	createBestSource(FileChannel channel) Creates a IRandomAccessSource based on memory mapping a file channel.
IRandomAccessSource	createBestSource(String filename) Creates a IRandomAccessSource based on a filename string.
IRandomAccessSource	createRanged(IRandomAccessSource source, long[] ranges)
IRandomAccessSource	createSource(byte[] data) Creates a IRandomAccessSource based on a byte array
IRandomAccessSource	createSource(InputStream inputStream) Creates a IRandomAccessSource based on an InputStream.
IRandomAccessSource	createSource(RandomAccessFile raf)
IRandomAccessSource	createSource(URL url) Creates a IRandomAccessSource based on a URL.
IRandomAccessSource	extractOrCreateSource(InputStream inputStream) Creates or extracts a IRandomAccessSource based on an InputStream.
RandomAccessSourceFactory	setExclusivelyLockFile(boolean exclusivelyLockFile)
RandomAccessSourceFactory	setForceRead(boolean forceRead) Determines whether the full content of the source will be read into memory
static void	setForceReadDefaultValue(boolean forceRead) Determines the default value for the forceRead flag
RandomAccessSourceFactory	setUsePlainRandomAccess(boolean usePlainRandomAccess) Determines whether RandomAccessFile should be used as the primary data access mechanism

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomAccessSourceFactory

public RandomAccessSourceFactory()

Creates a factory that will give preference to accessing the underling data source using memory mapped files

Method Detail

setForceReadDefaultValue

public static void setForceReadDefaultValue(boolean forceRead)

Determines the default value for the forceRead flag

Parameters:

forceRead - true if by default the full content will be read, false otherwise

setForceRead

public RandomAccessSourceFactory setForceRead(boolean forceRead)

Determines whether the full content of the source will be read into memory

Parameters:

forceRead - true if the full content will be read, false otherwise

Returns:

this object (this allows chaining of method calls)

setUsePlainRandomAccess

public RandomAccessSourceFactory setUsePlainRandomAccess(boolean usePlainRandomAccess)

Determines whether RandomAccessFile should be used as the primary data access mechanism

Parameters:

usePlainRandomAccess - whether RandomAccessFile should be used as the primary data access mechanism

Returns:

this object (this allows chaining of method calls)

setExclusivelyLockFile

public RandomAccessSourceFactory setExclusivelyLockFile(boolean exclusivelyLockFile)

createSource

public IRandomAccessSource createSource(byte[] data)

Creates a IRandomAccessSource based on a byte array

Parameters:

data - the byte array

Returns:

the newly created IRandomAccessSource

createSource

public IRandomAccessSource createSource(RandomAccessFile raf)
                                 throws IOException

Throws:

IOException

createSource

public IRandomAccessSource createSource(URL url)
                                 throws IOException

Creates a IRandomAccessSource based on a URL. The data available at the URL is read into memory and used as the source for the IRandomAccessSource

Parameters:

url - the url to read from

Returns:

the newly created IRandomAccessSource

Throws:

IOException - in case of any I/O error.

extractOrCreateSource

public IRandomAccessSource extractOrCreateSource(InputStream inputStream)
                                          throws IOException

Creates or extracts a IRandomAccessSource based on an InputStream.

If the InputStream is an instance of RASInputStream then extracts the source from it. Otherwise The full content of the InputStream is read into memory and used as the source for the IRandomAccessSource

Parameters:

inputStream - the stream to read from

Returns:

the newly created or extracted IRandomAccessSource

Throws:

IOException - in case of any I/O error.

createSource

public IRandomAccessSource createSource(InputStream inputStream)
                                 throws IOException

Creates a IRandomAccessSource based on an InputStream.

The full content of the InputStream is read into memory and used as the source for the IRandomAccessSource

Parameters:

inputStream - the stream to read from

Returns:

the newly created IRandomAccessSource

Throws:

IOException - in case of any I/O error.

createBestSource

public IRandomAccessSource createBestSource(String filename)
                                     throws IOException

Creates a IRandomAccessSource based on a filename string. If the filename describes a URL, a URL based source is created If the filename describes a file on disk, the contents may be read into memory (if forceRead is true), opened using memory mapped file channel (if usePlainRandomAccess is false), or opened using RandomAccessFile access (if usePlainRandomAccess is true) This call will automatically fail over to using RandomAccessFile if the memory map operation fails

Parameters:

filename - the name of the file or resource to create the IRandomAccessSource for

Returns:

the newly created IRandomAccessSource

Throws:

IOException - in case of any I/O error

createBestSource

public IRandomAccessSource createBestSource(FileChannel channel)
                                     throws IOException

Creates a IRandomAccessSource based on memory mapping a file channel. Unless you are explicitly working with a FileChannel already, it is better to use createBestSource(String). If the file is large, it will be opened using a paging strategy.

Parameters:

channel - the name of the file or resource to create the IRandomAccessSource for

Returns:

the newly created IRandomAccessSource

Throws:

IOException - in case of any I/O error

createRanged

public IRandomAccessSource createRanged(IRandomAccessSource source,
                                        long[] ranges)
                                 throws IOException

Throws:

IOException