org.apache.poi.poifs.nio

Class FileBackedDataSource

java.lang.Object

org.apache.poi.poifs.nio.DataSource

org.apache.poi.poifs.nio.FileBackedDataSource

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class FileBackedDataSource
extends DataSource
implements java.io.Closeable

A POIFS DataSource backed by a File

Constructor Summary

Constructors

Constructor and Description
FileBackedDataSource(java.io.File file)
FileBackedDataSource(java.io.File file, boolean readOnly)
FileBackedDataSource(java.nio.channels.FileChannel channel, boolean readOnly)
FileBackedDataSource(java.nio.channels.FileChannel channel, boolean readOnly, boolean closeChannelOnClose)
FileBackedDataSource(java.io.RandomAccessFile srcFile, boolean readOnly)

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying stream
void	copyTo(java.io.OutputStream stream) Copies the contents to the specified OutputStream
java.nio.channels.FileChannel	getChannel()
boolean	isWriteable()
java.nio.ByteBuffer	read(int length, long position)
void	releaseBuffer(java.nio.ByteBuffer buffer)
long	size()
void	write(java.nio.ByteBuffer src, long position)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBackedDataSource

public FileBackedDataSource(java.io.File file)
                     throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

FileBackedDataSource

public FileBackedDataSource(java.io.File file,
                            boolean readOnly)
                     throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

FileBackedDataSource

public FileBackedDataSource(java.io.RandomAccessFile srcFile,
                            boolean readOnly)

FileBackedDataSource

public FileBackedDataSource(java.nio.channels.FileChannel channel,
                            boolean readOnly)

FileBackedDataSource

public FileBackedDataSource(java.nio.channels.FileChannel channel,
                            boolean readOnly,
                            boolean closeChannelOnClose)

Since:

POI 5.1.0

Method Detail

isWriteable

public boolean isWriteable()

getChannel

public java.nio.channels.FileChannel getChannel()

read

public java.nio.ByteBuffer read(int length,
                                long position)
                         throws java.io.IOException

Specified by:

read in class DataSource

Throws:

java.io.IOException

write

public void write(java.nio.ByteBuffer src,
                  long position)
           throws java.io.IOException

Specified by:

write in class DataSource

Throws:

java.io.IOException

copyTo

public void copyTo(java.io.OutputStream stream)
            throws java.io.IOException

Description copied from class: DataSource

Copies the contents to the specified OutputStream

Specified by:

copyTo in class DataSource

Throws:

java.io.IOException

size

public long size()
          throws java.io.IOException

Specified by:

size in class DataSource

Throws:

java.io.IOException

releaseBuffer

public void releaseBuffer(java.nio.ByteBuffer buffer)

close

public void close()
           throws java.io.IOException

Description copied from class: DataSource

Close the underlying stream

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class DataSource

Throws:

java.io.IOException