org.apache.commons.vfs2

Interface RandomAccessContent

All Superinterfaces:

AutoCloseable, Closeable, DataInput, DataOutput

All Known Implementing Classes:

AbstractRandomAccessContent, AbstractRandomAccessStreamContent, HdfsRandomAccessContent, MonitorRandomAccessContent, RamFileRandomAccessContent

public interface RandomAccessContent
extends DataOutput, DataInput, Closeable

Provides random access over content.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this random access file stream and releases any system resources associated with the stream.
long	getFilePointer() Returns the current offset in this file.
InputStream	getInputStream() Get the input stream.
long	length() Returns the length of this file.
void	seek(long pos) Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs.
void	setLength(long newLength) Sets the length of this content.

Methods inherited from interface java.io.DataOutput

write, write, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Methods inherited from interface java.io.DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes

Method Detail

close

void close()
    throws IOException

Closes this random access file stream and releases any system resources associated with the stream.

A closed random access file cannot perform input or output operations and cannot be reopened.

If this file has an associated channel then the channel is closed as well.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an I/O error occurs.

getFilePointer

long getFilePointer()
             throws IOException

Returns the current offset in this file.

Returns:

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

Throws:

IOException - if an I/O error occurs.

getInputStream

InputStream getInputStream()
                    throws IOException

Get the input stream.

Notice: If you use seek(long) you have to re-get the InputStream

Returns:

the InputStream.

Throws:

IOException - if an I/O error occurs.

length

long length()
     throws IOException

Returns the length of this file.

Returns:

the length of this file, measured in bytes.

Throws:

IOException - if an I/O error occurs.

seek

void seek(long pos)
   throws IOException

Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs.

The offset may be set beyond the end of the file. Setting the offset beyond the end of the file does not change the file length. The file length will change only by writing after the offset has been set beyond the end of the file.

Notice: If you use getInputStream() you have to re-get the InputStream after calling seek(long)

Parameters:

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

Throws:

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

setLength

void setLength(long newLength)
        throws IOException

Sets the length of this content.

If the the newLength argument is smaller than length(), the content is truncated.

If the the newLength argument is greater than length(), the content grows with undefined data.

Parameters:

newLength - The desired content length

Throws:

IOException - If an I/O error occurs

Since:

2.1