li.cil.oc.api.fs

Interface Handle

public interface Handle

Represents a handle to a file opened from a FileSystem.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the handle.
long	length() The total length of the file.
long	position() The current position in the file.
int	read(byte[] into) Tries to read as much data from the file as fits into the specified array.
long	seek(long to) Jump to the specified position in the file, if possible.
void	write(byte[] value) Tries to write all the data from the specified array into the file.

Method Detail

position

long position()

The current position in the file.

length

long length()

The total length of the file.

close

void close()

Closes the handle.

For example, if there is an underlying stream, this should close that stream. Any future calls to read(byte[]) or write(byte[]) should throw an IOException after this function was called.

read

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

Tries to read as much data from the file as fits into the specified array.

For files opened in write or append mode this should always throw an exception.

Parameters:

into - the buffer to read the data into.

Returns:

the number of bytes read; -1 if there are no more bytes (EOF).

Throws:

java.io.IOException - if the file was opened in writing mode or an I/O error occurred or the file was already closed.

seek

long seek(long to)
          throws java.io.IOException

Jump to the specified position in the file, if possible.

For files opened in write or append mode this should always throw an exception.

Parameters:

to - the position in the file to jump to.

Returns:

the resulting position in the file.

Throws:

java.io.IOException - if the file was opened in write mode.

write

void write(byte[] value)
           throws java.io.IOException

Tries to write all the data from the specified array into the file.

For files opened in read mode this should always throw an exception.

Parameters:

value - the data to write into the file.

Throws:

java.io.IOException - if the file was opened in read-only mode, or another I/O error occurred (no more space, for example), or the file was already closed.