@NotThreadSafe public class RandomAccessFile extends Object implements DataInput, DataOutput, ucar.nc2.util.cache.FileCacheable, Closeable
By Russ Rew, based on BufferedRandomAccessFile by Alex McManus, based on Sun's source code for java.io.RandomAccessFile. For Alex McManus version from which this derives, see his Freeware Java Classes.
Must be thread confined - that is, can only be used by a single thread at a time..DataInput
,
DataOutput
,
RandomAccessFile
Modifier and Type | Field and Description |
---|---|
static int |
BIG_ENDIAN |
static int |
LITTLE_ENDIAN |
Constructor and Description |
---|
RandomAccessFile(String location,
String mode)
Constructor, default buffer size.
|
RandomAccessFile(String location,
String mode,
int bufferSize)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static RandomAccessFile |
acquire(String location) |
static RandomAccessFile |
acquire(String location,
int buffer_size) |
void |
close()
Close the file, and release any associated system resources.
|
static void |
eject(String location) |
static void |
enableDefaultGlobalFileCache() |
void |
flush()
Copy the contents of the buffer to the disk.
|
static List<String> |
getAllFiles()
Debugging, do not use.
|
int |
getBufferSize()
Get the buffer size
|
static boolean |
getDebugLeaks()
Debugging, do not use.
|
static long |
getDebugNbytes()
Debugging, do not use.
|
static int |
getDebugNseeks()
Debugging, do not use.
|
long |
getFilePointer()
Returns the current position in the file, where the next read or
write will occur.
|
static ucar.nc2.util.cache.FileCacheIF |
getGlobalFileCache() |
long |
getLastModified() |
String |
getLocation()
Get the file location, or name.
|
static int |
getMaxOpenFileCount() |
static long |
getOpenFileCount() |
static List<String> |
getOpenFiles()
Debugging, do not use.
|
RandomAccessFile |
getRandomAccessFile()
Allow access to the underlying java.io.RandomAccessFile.
|
boolean |
isAtEndOfFile()
Return true if file pointer is at end of file.
|
long |
length()
Get the length of the file.
|
void |
order(ByteOrder bo) |
void |
order(int endian)
Change the current endian mode.
|
void |
reacquire() |
int |
read()
Read a byte of data from the file, blocking until data is
available.
|
int |
read(byte[] b)
Read up to
b.length( ) bytes into an array. |
int |
read(byte[] b,
int off,
int len)
Read up to
len bytes into an array, at a specified
offset. |
boolean |
readBoolean()
Reads a
boolean from this file. |
byte |
readByte()
Reads a signed 8-bit value from this file.
|
int |
readBytes(byte[] b,
int off,
int len)
Read up to
len bytes into an array, at a specified
offset. |
byte[] |
readBytes(int count)
Read fully count number of bytes
|
char |
readChar()
Reads a Unicode character from this file.
|
double |
readDouble()
Reads a
double from this file. |
void |
readDouble(double[] pa,
int start,
int n)
Read an array of doubles
|
float |
readFloat()
Reads a
float from this file. |
void |
readFloat(float[] pa,
int start,
int n)
Read an array of floats
|
void |
readFully(byte[] b)
Reads
b.length bytes from this file into the byte
array. |
void |
readFully(byte[] b,
int off,
int len)
Reads exactly
len bytes from this file into the byte
array. |
int |
readInt()
Reads a signed 32-bit integer from this file.
|
void |
readInt(int[] pa,
int start,
int n)
Read an array of ints
|
int |
readIntUnbuffered(long pos)
Read an integer at the given position, bypassing all buffering.
|
String |
readLine()
Reads the next line of text from this file.
|
long |
readLong()
Reads a signed 64-bit integer from this file.
|
void |
readLong(long[] pa,
int start,
int n)
Read an array of longs
|
short |
readShort()
Reads a signed 16-bit number from this file.
|
void |
readShort(short[] pa,
int start,
int n)
Read an array of shorts
|
String |
readString(int nbytes)
Read a String of known length.
|
String |
readString(int nbytes,
Charset charset)
Read a String of known length.
|
String |
readStringMax(int nbytes)
Read a String of max length, zero terminate.
|
String |
readStringMax(int nbytes,
Charset charset)
Read a String of max length, zero terminate.
|
long |
readToByteChannel(WritableByteChannel dest,
long offset,
long nbytes)
Read
nbytes bytes, at the specified file offset, send to a WritableByteChannel. |
int |
readUnsignedByte()
Reads an unsigned 8-bit number from this file.
|
int |
readUnsignedShort()
Reads an unsigned 16-bit number from this file.
|
String |
readUTF()
Reads in a string from this file.
|
void |
release() |
boolean |
searchForward(KMPMatch match,
int maxBytes)
Search forward from the current pos, looking for a match.
|
void |
seek(long pos)
Set the position in the file for the next read or write.
|
void |
setBufferSize(int bufferSize)
Set the buffer size.
|
static void |
setDebugAccess(boolean b)
Debugging, do not use.
|
static void |
setDebugLeaks(boolean b)
Debugging, do not use in production.
|
void |
setExtendMode()
Set extendMode for truncated, yet valid files - old NetCDF code allowed this
when NOFILL on, and user doesnt write all variables.
|
void |
setFileCache(ucar.nc2.util.cache.FileCacheIF fileCache) |
static void |
setGlobalFileCache(ucar.nc2.util.cache.FileCacheIF _cache) |
void |
setMinLength(long minLength)
Make sure file is at least this long when its closed.
|
static void |
shutdown() |
int |
skipBytes(int n)
Skips exactly
n bytes of input. |
long |
skipBytes(long n) |
String |
toString()
Create a string representation of this object.
|
void |
unread()
Unread the last byte read.
|
void |
write(byte[] b)
Writes
b.length bytes from the specified byte array
starting at offset off to this file. |
void |
write(byte[] b,
int off,
int len)
Writes
len bytes from the specified byte array
starting at offset off to this file. |
void |
write(int b)
Write a byte to the file.
|
void |
writeBoolean(boolean v)
Writes a
boolean to the file as a 1-byte value. |
void |
writeBoolean(boolean[] pa,
int start,
int n)
Write an array of booleans
|
void |
writeByte(int v)
Writes a
byte to the file as a 1-byte value. |
void |
writeBytes(byte[] b,
int off,
int len)
Write
len bytes from an array to the file. |
void |
writeBytes(char[] b,
int off,
int len)
Writes the character array to the file as a sequence of bytes.
|
void |
writeBytes(String s)
Writes the string to the file as a sequence of bytes.
|
void |
writeChar(char[] pa,
int start,
int n)
Write an array of chars
|
void |
writeChar(int v)
Writes a
char to the file as a 2-byte value, high
byte first. |
void |
writeChars(String s)
Writes a string to the file as a sequence of characters.
|
void |
writeDouble(double v)
Converts the double argument to a
long using the
doubleToLongBits method in class Double ,
and then writes that long value to the file as an
8-byte quantity, high byte first. |
void |
writeDouble(double[] pa,
int start,
int n)
Write an array of doubles
|
void |
writeFloat(float v)
Converts the float argument to an
int using the
floatToIntBits method in class Float ,
and then writes that int value to the file as a
4-byte quantity, high byte first. |
void |
writeFloat(float[] pa,
int start,
int n)
Write an array of floats
|
void |
writeInt(int v)
Writes an
int to the file as four bytes, high byte first. |
void |
writeInt(int[] pa,
int start,
int n)
Write an array of ints
|
void |
writeLong(long v)
Writes a
long to the file as eight bytes, high byte first. |
void |
writeLong(long[] pa,
int start,
int n)
Write an array of longs
|
void |
writeShort(int v)
Writes a
short to the file as two bytes, high byte first. |
void |
writeShort(short[] pa,
int start,
int n)
Write an array of shorts
|
void |
writeUTF(String str)
Writes a string to the file using UTF-8 encoding in a
machine-independent manner.
|
public static final int BIG_ENDIAN
public static final int LITTLE_ENDIAN
public RandomAccessFile(String location, String mode) throws IOException
location
- location of the filemode
- same as for java.io.RandomAccessFile, usually "r" or "rw"IOException
- on open errorpublic RandomAccessFile(String location, String mode, int bufferSize) throws IOException
location
- location of the filemode
- same as for java.io.RandomAccessFilebufferSize
- size of buffer to use.IOException
- on open errorpublic static boolean getDebugLeaks()
public static void setDebugLeaks(boolean b)
b
- set true to track java.io.RandomAccessFilepublic static List<String> getOpenFiles()
public static long getOpenFileCount()
public static int getMaxOpenFileCount()
public static List<String> getAllFiles()
public static void setDebugAccess(boolean b)
b
- to debug file readingpublic static int getDebugNseeks()
public static long getDebugNbytes()
public static void enableDefaultGlobalFileCache()
public static void setGlobalFileCache(ucar.nc2.util.cache.FileCacheIF _cache)
public static ucar.nc2.util.cache.FileCacheIF getGlobalFileCache()
public static RandomAccessFile acquire(String location) throws IOException
IOException
public static RandomAccessFile acquire(String location, int buffer_size) throws IOException
IOException
public static void eject(String location)
public static void shutdown()
public RandomAccessFile getRandomAccessFile()
public void setBufferSize(int bufferSize)
bufferSize
- length in bytespublic int getBufferSize()
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in interface ucar.nc2.util.cache.FileCacheable
IOException
- if an I/O error occurrs.public void release()
release
in interface ucar.nc2.util.cache.FileCacheable
public void reacquire()
reacquire
in interface ucar.nc2.util.cache.FileCacheable
public void setFileCache(ucar.nc2.util.cache.FileCacheIF fileCache)
setFileCache
in interface ucar.nc2.util.cache.FileCacheable
public long getLastModified()
getLastModified
in interface ucar.nc2.util.cache.FileCacheable
public boolean isAtEndOfFile()
public void seek(long pos) throws IOException
pos
- the offset (in bytes) from the start of the file.IOException
- if an I/O error occurrs.public long getFilePointer()
public String getLocation()
getLocation
in interface ucar.nc2.util.cache.FileCacheable
public long length() throws IOException
IOException
- if an I/O error occurrs.public void order(int endian)
endian
- RandomAccessFile.BIG_ENDIAN or RandomAccessFile.LITTLE_ENDIANpublic void order(ByteOrder bo)
public void flush() throws IOException
IOException
- if an I/O error occurs.public void setMinLength(long minLength)
minLength
- minimum length of the file.public void setExtendMode()
public int read() throws IOException
IOException
- if an I/O error occurrs.public int readBytes(byte[] b, int off, int len) throws IOException
len
bytes into an array, at a specified
offset. This will block until at least one byte has been read.b
- the byte array to receive the bytes.off
- the offset in the array where copying will start.len
- the number of bytes to copy.IOException
- if an I/O error occurrs.public long readToByteChannel(WritableByteChannel dest, long offset, long nbytes) throws IOException
nbytes
bytes, at the specified file offset, send to a WritableByteChannel.
This will block until all bytes are read.
This uses the underlying file channel directly, bypassing all user buffers.dest
- write to this WritableByteChannel.offset
- the offset in the file where copying will start.nbytes
- the number of bytes to read.IOException
- if an I/O error occurs.public int read(byte[] b, int off, int len) throws IOException
len
bytes into an array, at a specified
offset. This will block until at least one byte has been read.b
- the byte array to receive the bytes.off
- the offset in the array where copying will start.len
- the number of bytes to copy.IOException
- if an I/O error occurrs.public int read(byte[] b) throws IOException
b.length( )
bytes into an array. This
will block until at least one byte has been read.b
- the byte array to receive the bytes.IOException
- if an I/O error occurrs.public byte[] readBytes(int count) throws IOException
count
- how many bytes tp readIOException
- if an I/O error occurrs.public final void readFully(byte[] b) throws IOException
b.length
bytes from this file into the byte
array. This method reads repeatedly from the file until all the
bytes are read. This method blocks until all the bytes are read,
the end of the stream is detected, or an exception is thrown.readFully
in interface DataInput
b
- the buffer into which the data is read.EOFException
- if this file reaches the end before reading
all the bytes.IOException
- if an I/O error occurs.public final void readFully(byte[] b, int off, int len) throws IOException
len
bytes from this file into the byte
array. This method reads repeatedly from the file until all the
bytes are read. This method blocks until all the bytes are read,
the end of the stream is detected, or an exception is thrown.readFully
in interface DataInput
b
- the buffer into which the data is read.off
- the start offset of the data.len
- the number of bytes to read.EOFException
- if this file reaches the end before reading
all the bytes.IOException
- if an I/O error occurs.public int skipBytes(int n) throws IOException
n
bytes of input.
This method blocks until all the bytes are skipped, the end of
the stream is detected, or an exception is thrown.skipBytes
in interface DataInput
n
- the number of bytes to be skipped.n
.EOFException
- if this file reaches the end before skipping
all the bytes.IOException
- if an I/O error occurs.public long skipBytes(long n) throws IOException
IOException
public void unread()
public void write(int b) throws IOException
write
in interface DataOutput
b
- write this byteIOException
- if an I/O error occurrs.public void writeBytes(byte[] b, int off, int len) throws IOException
len
bytes from an array to the file.b
- the array containing the data.off
- the offset in the array to the data.len
- the length of the data.IOException
- if an I/O error occurrs.public void write(byte[] b) throws IOException
b.length
bytes from the specified byte array
starting at offset off
to this file.write
in interface DataOutput
b
- the data.IOException
- if an I/O error occurs.public void write(byte[] b, int off, int len) throws IOException
len
bytes from the specified byte array
starting at offset off
to this file.write
in interface DataOutput
b
- the data.off
- the start offset in the data.len
- the number of bytes to write.IOException
- if an I/O error occurs.public final boolean readBoolean() throws IOException
boolean
from this file. This method reads a
single byte from the file. A value of 0
represents
false
. Any other value represents true
.
This method blocks until the byte is read, the end of the stream
is detected, or an exception is thrown.readBoolean
in interface DataInput
boolean
value read.EOFException
- if this file has reached the end.IOException
- if an I/O error occurs.public final byte readByte() throws IOException
b
, where
0 <= b <= 255
,
then the result is:
(byte)(b)
readByte
in interface DataInput
byte
.EOFException
- if this file has reached the end.IOException
- if an I/O error occurs.public final int readUnsignedByte() throws IOException
readUnsignedByte
in interface DataInput
EOFException
- if this file has reached the end.IOException
- if an I/O error occurs.public final short readShort() throws IOException
b1
and b2
, where each of the two values is
between 0
and 255
, inclusive, then the
result is equal to:
(short)((b1 << 8) | b2)
readShort
in interface DataInput
EOFException
- if this file reaches the end before reading
two bytes.IOException
- if an I/O error occurs.public final void readShort(short[] pa, int start, int n) throws IOException
pa
- read into this arraystart
- starting at pa[start]n
- read this many elementsIOException
- on read errorpublic final int readUnsignedShort() throws IOException
b1
and b2
, where
0 <= b1, b2 <= 255
,
then the result is equal to:
(b1 << 8) | b2
readUnsignedShort
in interface DataInput
EOFException
- if this file reaches the end before reading
two bytes.IOException
- if an I/O error occurs.public final char readChar() throws IOException
b1
and b2
, where
0 <= b1, b2 <= 255
,
then the result is equal to:
(char)((b1 << 8) | b2)
readChar
in interface DataInput
EOFException
- if this file reaches the end before reading
two bytes.IOException
- if an I/O error occurs.public final int readInt() throws IOException
b1
,
b2
, b3
, and b4
, where
0 <= b1, b2, b3, b4 <= 255
,
then the result is equal to:
(b1 << 24) | (b2 << 16) + (b3 << 8) + b4
readInt
in interface DataInput
int
.EOFException
- if this file reaches the end before reading
four bytes.IOException
- if an I/O error occurs.public final int readIntUnbuffered(long pos) throws IOException
pos
- read a byte at this positionIOException
- if an I/O error occurs.public final void readInt(int[] pa, int start, int n) throws IOException
pa
- read into this arraystart
- starting at pa[start]n
- read this many elementsIOException
- on read errorpublic final long readLong() throws IOException
b1
, b2
, b3
,
b4
, b5
, b6
,
b7
, and b8,
where:
0 <= b1, b2, b3, b4, b5, b6, b7, b8 <=255,
This method blocks until the eight bytes are read, the end of the stream is detected, or an exception is thrown.((long) b1 << 56) + ((long) b2 << 48) + ((long) b3 << 40) + ((long) b4 << 32) + ((long) b5 << 24) + ((long) b6 << 16) + ((long) b7 << 8) + b8
readLong
in interface DataInput
long
.EOFException
- if this file reaches the end before reading
eight bytes.IOException
- if an I/O error occurs.public final void readLong(long[] pa, int start, int n) throws IOException
pa
- read into this arraystart
- starting at pa[start]n
- read this many elementsIOException
- on read errorpublic final float readFloat() throws IOException
float
from this file. This method reads an
int
value as if by the readInt
method
and then converts that int
to a float
using the intBitsToFloat
method in class
Float
.
This method blocks until the four bytes are read, the end of the
stream is detected, or an exception is thrown.readFloat
in interface DataInput
float
.EOFException
- if this file reaches the end before reading
four bytes.IOException
- if an I/O error occurs.RandomAccessFile.readInt()
,
Float.intBitsToFloat(int)
public final void readFloat(float[] pa, int start, int n) throws IOException
pa
- read into this arraystart
- starting at pa[start]n
- read this many elementsIOException
- on read errorpublic final double readDouble() throws IOException
double
from this file. This method reads a
long
value as if by the readLong
method
and then converts that long
to a double
using the longBitsToDouble
method in
class Double
.
This method blocks until the eight bytes are read, the end of the
stream is detected, or an exception is thrown.readDouble
in interface DataInput
double
.EOFException
- if this file reaches the end before reading
eight bytes.IOException
- if an I/O error occurs.RandomAccessFile.readLong()
,
Double.longBitsToDouble(long)
public final void readDouble(double[] pa, int start, int n) throws IOException
pa
- read into this arraystart
- starting at pa[start]n
- read this many elementsIOException
- on read errorpublic final String readLine() throws IOException
A line of text is terminated by a carriage-return character
('\r'
), a newline character ('\n'
), a
carriage-return character immediately followed by a newline character,
or the end of the file. Line-terminating characters are discarded and
are not included as part of the string returned.
This method blocks until a newline character is read, a carriage return and the byte following it are read (to see if it is a newline), the end of the file is reached, or an exception is thrown.
readLine
in interface DataInput
IOException
- if an I/O error occurs.public final String readUTF() throws IOException
readUnsignedShort
. This value gives the number of
following bytes that are in the encoded string, not
the length of the resulting string. The following bytes are then
interpreted as bytes encoding characters in the UTF-8 format
and are converted into characters.
This method blocks until all the bytes are read, the end of the
stream is detected, or an exception is thrown.readUTF
in interface DataInput
EOFException
- if this file reaches the end before
reading all the bytes.IOException
- if an I/O error occurs.UTFDataFormatException
- if the bytes do not represent
valid UTF-8 encoding of a Unicode string.RandomAccessFile.readUnsignedShort()
public String readString(int nbytes) throws IOException
nbytes
- number of bytes to readIOException
- if an I/O error occurs.public String readString(int nbytes, Charset charset) throws IOException
nbytes
- number of bytes to reSadcharset
- the charset
to be used to decode the bytesIOException
- if an I/O error occurs.public String readStringMax(int nbytes) throws IOException
nbytes
- number of bytes to readIOException
- if an I/O error occurs.public String readStringMax(int nbytes, Charset charset) throws IOException
nbytes
- number of bytes to readcharset
- the charset
to be used to decode the bytesIOException
- if an I/O error occurs.public final void writeBoolean(boolean v) throws IOException
boolean
to the file as a 1-byte value. The
value true
is written out as the value
(byte)1
; the value false
is written out
as the value (byte)0
.writeBoolean
in interface DataOutput
v
- a boolean
value to be written.IOException
- if an I/O error occurs.public final void writeBoolean(boolean[] pa, int start, int n) throws IOException
pa
- write from this arraystart
- starting with this element in the arrayn
- write this number of elementsIOException
- on read errorpublic final void writeByte(int v) throws IOException
byte
to the file as a 1-byte value.writeByte
in interface DataOutput
v
- a byte
value to be written.IOException
- if an I/O error occurs.public final void writeShort(int v) throws IOException
short
to the file as two bytes, high byte first.writeShort
in interface DataOutput
v
- a short
to be written.IOException
- if an I/O error occurs.public final void writeShort(short[] pa, int start, int n) throws IOException
pa
- write from this arraystart
- starting with this element in the arrayn
- this number of elementsIOException
- on read errorpublic final void writeChar(int v) throws IOException
char
to the file as a 2-byte value, high
byte first.writeChar
in interface DataOutput
v
- a char
value to be written.IOException
- if an I/O error occurs.public final void writeChar(char[] pa, int start, int n) throws IOException
pa
- write from this arraystart
- starting with this element in the arrayn
- this number of elementsIOException
- on read errorpublic final void writeInt(int v) throws IOException
int
to the file as four bytes, high byte first.writeInt
in interface DataOutput
v
- an int
to be written.IOException
- if an I/O error occurs.public final void writeInt(int[] pa, int start, int n) throws IOException
pa
- write from this arraystart
- starting with this element in the arrayn
- write this number of elementsIOException
- on read errorpublic final void writeLong(long v) throws IOException
long
to the file as eight bytes, high byte first.writeLong
in interface DataOutput
v
- a long
to be written.IOException
- if an I/O error occurs.public final void writeLong(long[] pa, int start, int n) throws IOException
pa
- write from this arraystart
- starting with this element in the arrayn
- write this number of elementsIOException
- on read errorpublic final void writeFloat(float v) throws IOException
int
using the
floatToIntBits
method in class Float
,
and then writes that int
value to the file as a
4-byte quantity, high byte first.writeFloat
in interface DataOutput
v
- a float
value to be written.IOException
- if an I/O error occurs.Float.floatToIntBits(float)
public final void writeFloat(float[] pa, int start, int n) throws IOException
pa
- write from this arraystart
- starting with this element in the arrayn
- write this number of elementsIOException
- on read errorpublic final void writeDouble(double v) throws IOException
long
using the
doubleToLongBits
method in class Double
,
and then writes that long
value to the file as an
8-byte quantity, high byte first.writeDouble
in interface DataOutput
v
- a double
value to be written.IOException
- if an I/O error occurs.Double.doubleToLongBits(double)
public final void writeDouble(double[] pa, int start, int n) throws IOException
pa
- write from this arraystart
- starting with this element in the arrayn
- write this number of elementsIOException
- on read errorpublic final void writeBytes(String s) throws IOException
writeBytes
in interface DataOutput
s
- a string of bytes to be written.IOException
- if an I/O error occurs.public final void writeBytes(char[] b, int off, int len) throws IOException
b
- a character array of bytes to be written.off
- the index of the first character to write.len
- the number of characters to write.IOException
- if an I/O error occurs.public final void writeChars(String s) throws IOException
writeChar
method.writeChars
in interface DataOutput
s
- a String
value to be written.IOException
- if an I/O error occurs.RandomAccessFile.writeChar(int)
public final void writeUTF(String str) throws IOException
writeShort
method giving the number of bytes to
follow. This value is the number of bytes actually written out,
not the length of the string. Following the length, each character
of the string is output, in sequence, using the UTF-8 encoding
for each character.writeUTF
in interface DataOutput
str
- a string to be written.IOException
- if an I/O error occurs.public String toString()
public boolean searchForward(KMPMatch match, int maxBytes) throws IOException
match
- the match to look for.maxBytes
- maximum number of bytes to search. use -1 for allIOException
- on read error