org.apache.commons.io.input

Class Tailer.RandomAccessFileBridge

java.lang.Object

org.apache.commons.io.input.Tailer.RandomAccessFileBridge

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Tailer.RandomAccessResourceBridge

Enclosing class:

Tailer

private static final class Tailer.RandomAccessFileBridge
extends java.lang.Object
implements Tailer.RandomAccessResourceBridge

Bridges random access to a RandomAccessFile.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.RandomAccessFile	randomAccessFile

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RandomAccessFileBridge(java.io.File file, java.lang.String mode)

Method Summary

Modifier and Type	Method and Description
void	close()
long	getPointer() Gets the current offset in this tailable.
int	read(byte[] b) Reads up to b.length bytes of data from this tailable into an array of bytes.
void	seek(long position) Sets the file-pointer offset, measured from the beginning of this tailable, at which the next read or write occurs.

Methods inherited from class java.lang.Object

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

Field Detail

randomAccessFile

private final java.io.RandomAccessFile randomAccessFile

Constructor Detail

RandomAccessFileBridge

private RandomAccessFileBridge(java.io.File file,
                               java.lang.String mode)
                        throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getPointer

public long getPointer()
                throws java.io.IOException

Description copied from interface: Tailer.RandomAccessResourceBridge

Gets the current offset in this tailable.

Specified by:

getPointer in interface Tailer.RandomAccessResourceBridge

Returns:

the offset from the beginning of the tailable, in bytes, at which the next read or write occurs.

Throws:

java.io.IOException - if an I/O error occurs.

read

public int read(byte[] b)
         throws java.io.IOException

Description copied from interface: Tailer.RandomAccessResourceBridge

Reads up to b.length bytes of data from this tailable into an array of bytes. This method blocks until at least one byte of input is available.

Specified by:

read in interface Tailer.RandomAccessResourceBridge

Parameters:

b - the buffer into which the data is read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of this tailable has been reached.

Throws:

java.io.IOException - If the first byte cannot be read for any reason other than end of tailable, or if the random access tailable has been closed, or if some other I/O error occurs.

seek

public void seek(long position)
          throws java.io.IOException

Description copied from interface: Tailer.RandomAccessResourceBridge

Sets the file-pointer offset, measured from the beginning of this tailable, at which the next read or write occurs. The offset may be set beyond the end of the tailable. Setting the offset beyond the end of the tailable does not change the tailable length. The tailable length will change only by writing after the offset has been set beyond the end of the tailable.

Specified by:

seek in interface Tailer.RandomAccessResourceBridge

Parameters:

position - the offset position, measured in bytes from the beginning of the tailable, at which to set the tailable pointer.

Throws:

java.io.IOException - if pos is less than 0 or if an I/O error occurs.