Apache POI - Common 5.3.0 · org.apache.poi.poifs.nio.FileBackedDataSource

Field Summary

Modifier and Type	Field and Description
private final IdentityHashMap<ByteBuffer, ByteBuffer>	buffersToClean
private final FileChannel	channel
private Long	channelSize
private final boolean	closeChannelOnClose
private static final Logger	LOG
private final RandomAccessFile	srcFile
private final boolean	writable

Constructor Summary

Access	Constructor and Description
public	FileBackedDataSource(File file)
public	FileBackedDataSource(File file, boolean readOnly)
public	FileBackedDataSource(RandomAccessFile srcFile, boolean readOnly)
public	FileBackedDataSource(FileChannel channel, boolean readOnly)
public	FileBackedDataSource(FileChannel channel, boolean readOnly, boolean closeChannelOnClose)
private	FileBackedDataSource(RandomAccessFile srcFile, FileChannel channel, boolean readOnly, boolean closeChannelOnClose)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract org.apache.poi.poifs.nio.DataSource.close. Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public void	copyTo(OutputStream stream) Implements abstract org.apache.poi.poifs.nio.DataSource.copyTo. Copies the contents to the specified OutputStream
public FileChannel	getChannel()
public boolean	isWriteable()
private static RandomAccessFile	newSrcFile(File file, String mode)
public ByteBuffer	read(int length, long position) Implements abstract org.apache.poi.poifs.nio.DataSource.read.
public void	releaseBuffer(ByteBuffer buffer)
public long	size() Implements abstract org.apache.poi.poifs.nio.DataSource.size.
private static void	unmap(final ByteBuffer buffer)
public void	write(ByteBuffer src, long position) Implements abstract org.apache.poi.poifs.nio.DataSource.write.

Field Detail

buffersToClean	back to summary
private final IdentityHashMap<ByteBuffer, ByteBuffer> buffersToClean

channel	back to summary
private final FileChannel channel

channelSize	back to summary
private Long channelSize

closeChannelOnClose	back to summary
private final boolean closeChannelOnClose

LOG	back to summary
private static final Logger LOG

srcFile	back to summary
private final RandomAccessFile srcFile

writable	back to summary
private final boolean writable

Constructor Detail

FileBackedDataSource	back to summary
public FileBackedDataSource(File file) throws FileNotFoundException

FileBackedDataSource	back to summary
public FileBackedDataSource(File file, boolean readOnly) throws FileNotFoundException

FileBackedDataSource	back to summary
public FileBackedDataSource(RandomAccessFile srcFile, boolean readOnly)

FileBackedDataSource	back to summary
public FileBackedDataSource(FileChannel channel, boolean readOnly)

FileBackedDataSource	back to summary
public FileBackedDataSource(FileChannel channel, boolean readOnly, boolean closeChannelOnClose) Since POI 5.1.0

FileBackedDataSource	back to summary
private FileBackedDataSource(RandomAccessFile srcFile, FileChannel channel, boolean readOnly, boolean closeChannelOnClose)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements abstract org.apache.poi.poifs.nio.DataSource.close. Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements abstract org.apache.poi.poifs.nio.DataSource.close.

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

copyTo	back to summary
public void copyTo(OutputStream stream) throws IOException Implements abstract org.apache.poi.poifs.nio.DataSource.copyTo. Doc from org.apache.poi.poifs.nio.DataSource.copyTo. Copies the contents to the specified OutputStream Annotations @Override

copyTo

back to summary

public void copyTo(OutputStream stream) throws IOException

Implements abstract org.apache.poi.poifs.nio.DataSource.copyTo.

Doc from org.apache.poi.poifs.nio.DataSource.copyTo.

Copies the contents to the specified OutputStream

Annotations

@Override

getChannel	back to summary
public FileChannel getChannel()

isWriteable	back to summary
public boolean isWriteable()

newSrcFile	back to summary
private static RandomAccessFile newSrcFile(File file, String mode) throws FileNotFoundException

read	back to summary
public ByteBuffer read(int length, long position) throws IOException Implements abstract org.apache.poi.poifs.nio.DataSource.read. Annotations @Override

read

back to summary

public ByteBuffer read(int length, long position) throws IOException

Implements abstract org.apache.poi.poifs.nio.DataSource.read.

Annotations

@Override

releaseBuffer	back to summary
public void releaseBuffer(ByteBuffer buffer)

size	back to summary
public long size() throws IOException Implements abstract org.apache.poi.poifs.nio.DataSource.size. Annotations @Override

size

back to summary

public long size() throws IOException

Implements abstract org.apache.poi.poifs.nio.DataSource.size.

Annotations

@Override

unmap	back to summary
private static void unmap(final ByteBuffer buffer)

write	back to summary
public void write(ByteBuffer src, long position) throws IOException Implements abstract org.apache.poi.poifs.nio.DataSource.write. Annotations @Override

write

back to summary

public void write(ByteBuffer src, long position) throws IOException

Implements abstract org.apache.poi.poifs.nio.DataSource.write.

Annotations

@Override

public Class FileBackedDataSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail