Module org.sejda.io

Package org.sejda.io

Class SeekableSources

java.lang.Object

org.sejda.io.SeekableSources

public final class SeekableSources
extends Object

This class consists of solely static methods to create the most appropriate SeekableSource based on the given input or to bridge SeekableSources to the more traditional InputStream or other standard I/O classes.

Author:

Andrea Vacondio

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISABLE_MEMORY_MAPPED_PROPERTY	Threshold size in bytes where the SeekableSources method will switch to MemoryMappedSeekableSource(File)
static final String	INPUT_BUFFER_SIZE_PROPERTY	Buffer size for BufferedSeekableSource
static final String	MAPPED_SIZE_THRESHOLD_PROPERTY	Threshold size in bytes where the SeekableSources method will switch to MemoryMappedSeekableSource(File)
static final String	MEMORY_MAPPED_PAGE_SIZE_PROPERTY	Size of the pages used by MemoryMappedSeekableSource

Method Summary

Modifier and Type	Method	Description
static OffsettableSeekableSource	asOffsettable(SeekableSource source)	Factory method to create an OffsettableSeekableSource from a SeekableSource
static SeekableSource	inMemorySeekableSourceFrom(byte[] bytes)	Factory method to create a SeekableSource from a byte array.
static SeekableSource	inMemorySeekableSourceFrom(InputStream stream)	Factory method to create a SeekableSource from a InputStream.
static SeekableSource	onTempFileSeekableSourceFrom(InputStream stream)	Factory method to create a SeekableSource from a InputStream.
static SeekableSource	onTempFileSeekableSourceFrom(InputStream stream, String filenameHint)	Factory method to create a SeekableSource from a InputStream.
static SeekableSource	seekableSourceFrom(File file)	Factory method to create a SeekableSource from a File.
static SeekableSource	seekableSourceFrom(Path path)	Factory method to create a SeekableSource from a Path.

Methods inherited from class java.lang.Object

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

Field Details

MAPPED_SIZE_THRESHOLD_PROPERTY

public static final String MAPPED_SIZE_THRESHOLD_PROPERTY

Threshold size in bytes where the SeekableSources method will switch to MemoryMappedSeekableSource(File)

See Also:

• Constant Field Values

DISABLE_MEMORY_MAPPED_PROPERTY

public static final String DISABLE_MEMORY_MAPPED_PROPERTY

Threshold size in bytes where the SeekableSources method will switch to MemoryMappedSeekableSource(File)

See Also:

• Constant Field Values

INPUT_BUFFER_SIZE_PROPERTY

public static final String INPUT_BUFFER_SIZE_PROPERTY

Buffer size for BufferedSeekableSource

See Also:

• Constant Field Values

MEMORY_MAPPED_PAGE_SIZE_PROPERTY

public static final String MEMORY_MAPPED_PAGE_SIZE_PROPERTY

Size of the pages used by MemoryMappedSeekableSource

See Also:

• Constant Field Values

Method Details

seekableSourceFrom

public static SeekableSource seekableSourceFrom(File file)
                                         throws IOException

Factory method to create a SeekableSource from a File. An attempt is made to return the best SeekableSource implementation based on the size of the file and bitness of the JVM.

Parameters:

file -

Returns:

a SeekableSource from the given file.

Throws:

IOException

seekableSourceFrom

public static SeekableSource seekableSourceFrom(Path path)
                                         throws IOException

Factory method to create a SeekableSource from a Path. An attempt is made to return the best SeekableSource implementation based on the size of the file and bitness of the JVM.

Parameters:

path -

Returns:

a SeekableSource from the given file.

Throws:

IOException

inMemorySeekableSourceFrom

public static SeekableSource inMemorySeekableSourceFrom(InputStream stream)
                                                 throws IOException

Factory method to create a SeekableSource from a InputStream. The whole stream is read and stored in a byte array with a max size of 2GB.

Parameters:

stream -

Returns:

a SeekableSource from the given stream.

Throws:

IOException

inMemorySeekableSourceFrom

public static SeekableSource inMemorySeekableSourceFrom(byte[] bytes)

Factory method to create a SeekableSource from a byte array.

Parameters:

bytes -

Returns:

a SeekableSource wrapping the given byte array.

onTempFileSeekableSourceFrom

public static SeekableSource onTempFileSeekableSourceFrom(InputStream stream)
                                                   throws IOException

Factory method to create a SeekableSource from a InputStream. The whole stream is copied to a temporary file.

Parameters:

stream -

Returns:

a SeekableSource from the given stream.

Throws:

IOException

onTempFileSeekableSourceFrom

public static SeekableSource onTempFileSeekableSourceFrom(InputStream stream,
 String filenameHint)
                                                   throws IOException

Factory method to create a SeekableSource from a InputStream. The whole stream is copied to a temporary file.

Parameters:

stream -

filenameHint - name to use for the temp file that will be created

Returns:

a SeekableSource from the given stream.

Throws:

IOException

asOffsettable

public static OffsettableSeekableSource asOffsettable(SeekableSource source)

Factory method to create an OffsettableSeekableSource from a SeekableSource

Parameters:

source -

Returns: