@ThreadSafe public class LockReadOnlyFile extends DecoratingReadOnlyFile
Modifier and Type | Field and Description |
---|---|
protected Lock |
lock
The object to synchronize on.
|
delegate
Constructor and Description |
---|
LockReadOnlyFile(ReadOnlyFile rof,
Lock lock)
Constructs a new synchronized read only file.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this read-only file and releases any non-heap resources
allocated for it.
|
long |
getFilePointer()
Returns the current byte position in the file as a zero-based index.
|
long |
length()
Returns the length of the file in bytes.
|
int |
read()
Reads and returns the next byte or -1 if the end of the file has been
reached.
|
int |
read(byte[] b,
int off,
int len)
Reads up to
len bytes of data from this read only file into
the given array. |
void |
readFully(byte[] b,
int off,
int len)
Reads
len bytes into the given buffer at the given position. |
void |
seek(long pos)
Sets the current byte position in the file as a zero-based index at
which the next read occurs.
|
toString
read, readFully
protected final Lock lock
@CreatesObligation public LockReadOnlyFile(@Nullable @WillCloseWhenClosed ReadOnlyFile rof, Lock lock)
rof
- the input stream to wrap in this decorator.lock
- the object to synchronize on.public void close() throws IOException
ReadOnlyFile
close
in interface ReadOnlyFile
close
in interface Closeable
close
in interface AutoCloseable
close
in class DecoratingReadOnlyFile
IOException
- On any I/O failure.public long getFilePointer() throws IOException
ReadOnlyFile
getFilePointer
in interface ReadOnlyFile
getFilePointer
in class DecoratingReadOnlyFile
IOException
- On any I/O failure.public long length() throws IOException
ReadOnlyFile
length
in interface ReadOnlyFile
length
in class DecoratingReadOnlyFile
IOException
- On any I/O failure.public int read() throws IOException
ReadOnlyFile
read
in interface ReadOnlyFile
read
in class DecoratingReadOnlyFile
IOException
- On any I/O failure.public int read(byte[] b, int off, int len) throws IOException
ReadOnlyFile
len
bytes of data from this read only file into
the given array.
This method blocks until at least one byte of input is available unless
len
is zero.read
in interface ReadOnlyFile
read
in class DecoratingReadOnlyFile
b
- The buffer to fill with data.off
- The start offset of the data.len
- The maximum number of bytes to read.-1
if there is
no more data because the end of the file has been reached.IOException
- On any I/O failure.public void readFully(byte[] b, int off, int len) throws IOException
ReadOnlyFile
len
bytes into the given buffer at the given position.readFully
in interface ReadOnlyFile
readFully
in class AbstractReadOnlyFile
b
- the buffer to fill with data.off
- the start offset of the data.len
- the number of bytes to read.EOFException
- If less than len
bytes are available
before the end of the file is reached.IOException
- On any I/O failure.public void seek(long pos) throws IOException
ReadOnlyFile
DefaultReadOnlyFile
passes "r"
as a parameter to the constructor of its super-class
RandomAccessFile
.
With Oracle's JSE implementation, on the Windows platform this
implementation allows to seek past the end of file, but on the Linux
platform it doesn't.seek
in interface ReadOnlyFile
seek
in class DecoratingReadOnlyFile
pos
- The current byte position as a zero-based index.IOException
- If pos
is less than 0
or on any
I/O failure.Copyright © 2005–2018 Schlichtherle IT Services. All rights reserved.