|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bigzip.plugin.compression.io.AbstractStream | +--com.bigzip.plugin.compression.io.IOStream
This class is used for writing to and reading from data files. It
also supports writing and reading in little endian bit order. These
methods that support this order are denoted by an LE extension.
The .zip file format and compression scheme is the copyright of PKWARE, Inc.
Field Summary | |
static int |
BIG_ENDIAN
|
static int |
LITTLE_ENDIAN
|
static int |
LONG32_INT16
|
static int |
LONG64_INT32
|
Fields inherited from class com.bigzip.plugin.compression.io.AbstractStream |
clientStream |
Constructor Summary | |
IOStream(java.io.RandomAccessFile raf)
Creates an IO stream built on top of the specified underlying random access stream. |
|
IOStream(java.io.RandomAccessFile raf,
int typeSize,
int typeFormat)
Creates an IO stream built on top of the specified underlying random access stream. |
Method Summary | |
void |
close()
Closes this random access stream and releases any system resources associated with the stream. |
void |
ensureOpen()
Check to make sure that this stream has not been closed |
void |
finish()
Required only to catch the the calls to super by inhereting streams. |
long |
getFilePointer()
Returns the current offset in this file. |
java.io.RandomAccessFile |
getRandomAccessFile()
Provides access the specified underlying random access stream. |
boolean |
isClosed()
|
long |
length()
Returns the length of this file. |
int |
read()
Reads the next byte of data from this random access stream. |
int |
read(byte[] b,
int off,
int len)
Reads up to len bytes of data from this random access stream
into an array of bytes. |
boolean |
readBoolean()
Reads a boolean from this file. |
byte |
readByte()
Reads a signed 8-bit value from this file. |
char |
readChar()
Reads a Unicode character from this file. |
int |
readDirect(byte[] b,
int off,
int len)
|
double |
readDouble()
Reads a double from this file. |
float |
readFloat()
Reads a float from this file. |
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/16-bit integer from this file. |
int |
readInt(byte[] b,
int off)
Reads a signed 32/16-bit integer from a buffer. |
java.lang.String |
readLine()
Reads the next line of text from this file. |
long |
readLong()
Reads a signed 64/32-bit long from this file. |
long |
readLong(byte[] b,
int off)
Reads a signed 64/32-bit long from a buffer. |
short |
readShort()
Reads a signed 16-bit number from this file. |
int |
readUnsignedByte()
Reads an unsigned 8-bit number from this file. |
int |
readUnsignedShort()
Reads an unsigned 16-bit number from this file. |
java.lang.String |
readUTF()
Reads in a string from 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 |
setClosed(boolean b)
Sets the closed status of the file. |
void |
setRandomAccessFile(java.io.RandomAccessFile raf)
Assigns a different IO stream built on top of the specified underlying random access stream. |
int |
skipBytes(int n)
Attempts to skip over n bytes of input discarding the
skipped bytes. |
void |
write(byte[] b)
Writes b.length bytes to this random access stream. |
void |
write(byte[] b,
int off,
int len)
Writes len bytes from the specified
byte array starting at offset off to
this random access stream. |
void |
write(int b)
Writes the specified byte to this random access stream. |
void |
writeBoolean(boolean v)
Writes a boolean to the file as a 1-byte value. |
void |
writeByte(int v)
Writes a byte to the file as a 1-byte value. |
void |
writeBytes(java.lang.String s)
Writes the string to the file as a sequence of bytes. |
void |
writeChar(int v)
Writes a char to the file as a 2-byte value, high
byte first. |
void |
writeChars(java.lang.String s)
Writes a string to the file as a sequence of characters. |
void |
writeDirect(byte[] b,
int off,
int len)
|
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 or 4-byte quantity, high byte first. |
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 or 2-byte quantity, high byte first. |
void |
writeFully(byte[] b,
int off,
int len)
Writes len bytes from the specified
byte array starting at offset off to
this random access stream. |
void |
writeInt(int v)
Writes an int to the file. |
void |
writeLong(long v)
Writes a long to the file. |
void |
writeShort(int v)
Writes a short to the file as two bytes, high byte first. |
void |
writeUTF(java.lang.String str)
Writes a string to the file using UTF-8 encoding in a machine-independent manner. |
Methods inherited from class com.bigzip.plugin.compression.io.AbstractStream |
read, readDirect, setClientStream, writeDirect |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int LONG32_INT16
public static final int LONG64_INT32
public static final int LITTLE_ENDIAN
public static final int BIG_ENDIAN
Constructor Detail |
public IOStream(java.io.RandomAccessFile raf)
The stream will default to java standard bits and order for data types. ie. BIG_ENDIAN and LONG64_INT32
raf
- the underlying random access stream to be assigned to
the field this.raf for later use.public IOStream(java.io.RandomAccessFile raf, int typeSize, int typeFormat)
raf
- the underlying random access stream to be assigned to
the field this.raf for later use.typeSize
- the bit size of integers and longs.typeFormat
- the byte format of data types, little or big
endian.bigzip.plugin.compression.io.IOStream#LONG64_INT32
,
bigzip.plugin.compression.io.IOStream#LONG32_INT16
,
bigzip.plugin.compression.io.IOStream#BIG_ENDIAN
,
bigzip.plugin.compression.io.IOStream#LITTLE_ENDIAN
Method Detail |
public java.io.RandomAccessFile getRandomAccessFile()
public void setRandomAccessFile(java.io.RandomAccessFile raf)
raf
- the underlying random access stream to be assigned to
the field this.raf for later use.public boolean isClosed()
isClosed
in class AbstractStream
public void setClosed(boolean b)
setClosed
in class AbstractStream
b
- closed status.public void ensureOpen() throws java.io.IOException
ensureOpen
in class AbstractStream
java.io.IOException
- If the stream is no longer openedpublic int read() throws java.io.IOException
int
in the range
0
to 255
. If no byte is available
because the end of the stream has been reached, the value
-1
is returned. This method blocks until input data
is available, the end of the stream is detected, or an exception
is thrown.
This method
simply performs raf.read()
and returns the result.
read
in class AbstractStream
-1
if the end of the
stream is reached.java.io.IOException
- if an I/O error occurs.com.shaik.bigzip.archive.zip.IOStream#raf
public int read(byte[] b, int off, int len) throws java.io.IOException
len
bytes of data from this random access stream
into an array of bytes. This method blocks until some input is
available.
This method simply performs raf.read(b, off, len)
and returns the result.
read
in class AbstractStream
b
- the buffer into which the data is read.off
- the start offset of the data.len
- the maximum number of bytes read.-1
if there is no more data because the end of
the stream has been reached.java.io.IOException
- if an I/O error occurs.com.shaik.bigzip.archive.zip.IOStream#in
public void readFully(byte[] b, int off, int len) throws java.io.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 class AbstractStream
b
- the buffer into which the data is read.off
- the start offset of the data.len
- the number of bytes to read.java.io.EOFException
- if this file reaches the end before reading
all the bytes.java.io.IOException
- if an I/O error occurs.public int readDirect(byte[] b, int off, int len) throws java.io.IOException
readDirect
in class AbstractStream
public void write(int b) throws java.io.IOException
byte
to this random access stream.
The write
method of IOStream
calls the write
method of its underlying random access stream,
that is, it performs raf.write(b).
Implements the write method of RandomAccessFile.
write
in class AbstractStream
b
- the byte
.java.io.IOException
- if an I/O error occurs.public void write(byte[] b) throws java.io.IOException
b.length
bytes to this random access stream.
The write
method of IOStream
calls its write
method of three arguments with the
arguments b
, 0
, and
b.length
.
Note that this method does not call the one-argument
write
method of its underlying stream with the single
argument b
.
write
in class AbstractStream
b
- the data to be written.java.io.IOException
- if an I/O error occurs.com.shaik.bigzip.archive.zip.IOStream#write(byte[], int, int)
public void write(byte[] b, int off, int len) throws java.io.IOException
len
bytes from the specified
byte
array starting at offset off
to
this random access stream.
The write
method of IOStream
calls the write
method of one argument on each
byte
to output.
Note that this method does not call the write
method
of its underlying random access stream with the same arguments. Subclasses
of IOStream
should provide a more efficient
implementation of this method.
write
in class AbstractStream
b
- the data.off
- the start offset in the data.len
- the number of bytes to write.java.io.IOException
- if an I/O error occurs.com.shaik.bigzip.archive.zip.IOStream#write(int)
public void writeFully(byte[] b, int off, int len) throws java.io.IOException
len
bytes from the specified
byte
array starting at offset off
to
this random access stream.
The write
method of IOStream
calls the write
method of one argument on each
byte
to output.
Note that this method does not call the write
method
of its underlying random access stream with the same arguments. Subclasses
of IOStream
should provide a more efficient
implementation of this method.
writeFully
in class AbstractStream
b
- the data.off
- the start offset in the data.len
- the number of bytes to write.java.io.IOException
- if an I/O error occurs.com.shaik.bigzip.archive.zip.IOStream#write(int)
public void writeDirect(byte[] b, int off, int len) throws java.io.IOException
writeDirect
in class AbstractStream
public int skipBytes(int n) throws java.io.IOException
n
bytes of input discarding the
skipped bytes.
This method may skip over some smaller number of bytes, possibly zero.
This may result from any of a number of conditions; reaching end of
file before n
bytes have been skipped is only one
possibility. This method never throws an EOFException
.
The actual number of bytes skipped is returned. If n
is negative, no bytes are skipped.
skipBytes
in class AbstractStream
n
- the number of bytes to be skipped.java.io.IOException
- if an I/O error occurs.public void close() throws java.io.IOException
The close
method of IOStream
calls its flush
method, and then calls the
close
method of its underlying random access stream.
close
in class AbstractStream
java.io.IOException
- if an I/O error occurs.public long getFilePointer() throws java.io.IOException
getFilePointer
in class AbstractStream
java.io.IOException
- if an I/O error occurs.public void seek(long pos) throws java.io.IOException
seek
in class AbstractStream
pos
- the offset position, measured in bytes from the
beginning of the file, at which to set the file
pointer.java.io.IOException
- if pos
is less than
0
or if an I/O error occurs.public long length() throws java.io.IOException
length
in class AbstractStream
java.io.IOException
- if an I/O error occurs.public void finish() throws java.io.IOException
finish
in class AbstractStream
public boolean readBoolean() throws java.io.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 class AbstractStream
boolean
value read.java.io.EOFException
- if this file has reached the end.java.io.IOException
- if an I/O error occurs.public byte readByte() throws java.io.IOException
b
, where
0 <= b <= 255
,
then the result is:
(byte)(b)
This method blocks until the byte is read, the end of the stream is detected, or an exception is thrown.
readByte
in class AbstractStream
byte
.java.io.EOFException
- if this file has reached the end.java.io.IOException
- if an I/O error occurs.public int readUnsignedByte() throws java.io.IOException
This method blocks until the byte is read, the end of the stream is detected, or an exception is thrown.
readUnsignedByte
in class AbstractStream
java.io.EOFException
- if this file has reached the end.java.io.IOException
- if an I/O error occurs.public final short readShort() throws java.io.IOException
This method blocks until the two bytes are read, the end of the stream is detected, or an exception is thrown.
readShort
in class AbstractStream
java.io.EOFException
- if this file reaches the end before reading
two bytes.java.io.IOException
- if an I/O error occurs.public final int readUnsignedShort() throws java.io.IOException
This method blocks until the two bytes are read, the end of the stream is detected, or an exception is thrown.
readUnsignedShort
in class AbstractStream
java.io.EOFException
- if this file reaches the end before reading
two bytes.java.io.IOException
- if an I/O error occurs.public char readChar() throws java.io.IOException
This method blocks until the two bytes are read, the end of the stream is detected, or an exception is thrown.
readChar
in class AbstractStream
java.io.EOFException
- if this file reaches the end before reading
two bytes.java.io.IOException
- if an I/O error occurs.public final int readInt() throws java.io.IOException
This method blocks until the four bytes are read, the end of the stream is detected, or an exception is thrown.
readInt
in class AbstractStream
int
.java.io.EOFException
- if this file reaches the end before reading
four bytes.java.io.IOException
- if an I/O error occurs.public int readInt(byte[] b, int off)
readInt
in class AbstractStream
b
- The byte array containing the valueoff
- The starting position of the value in the arrayint
.public long readLong() throws java.io.IOException
This method blocks until the eight bytes are read, the end of the stream is detected, or an exception is thrown.
readLong
in class AbstractStream
long
.java.io.EOFException
- if this file reaches the end before reading
eight bytes.java.io.IOException
- if an I/O error occurs.public long readLong(byte[] b, int off)
readLong
in class AbstractStream
b
- The byte array containing the valueoff
- The starting position of the value in the arraylong
.public float readFloat() throws java.io.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 class AbstractStream
float
.public double readDouble() throws java.io.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 class AbstractStream
double
.public java.lang.String readLine() throws java.io.IOException
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 stream is detected, or an exception is thrown.
readLine
in class AbstractStream
public java.lang.String readUTF() throws java.io.IOException
readUTF
in class AbstractStream
public void writeBoolean(boolean v) throws java.io.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 class AbstractStream
v
- a boolean
value to be written.public void writeByte(int v) throws java.io.IOException
byte
to the file as a 1-byte value.writeByte
in class AbstractStream
v
- a byte
value to be written.public void writeShort(int v) throws java.io.IOException
short
to the file as two bytes, high byte first.writeShort
in class AbstractStream
v
- a short
to be written.public void writeChar(int v) throws java.io.IOException
char
to the file as a 2-byte value, high
byte first.writeChar
in class AbstractStream
v
- a char
value to be written.public void writeInt(int v) throws java.io.IOException
int
to the file.writeInt
in class AbstractStream
v
- an int
to be written.java.io.IOException
- if an I/O error occurs.public void writeLong(long v) throws java.io.IOException
long
to the file.writeLong
in class AbstractStream
v
- a long
to be written.java.io.IOException
- if an I/O error occurs.public void writeFloat(float v) throws java.io.IOException
int
using the
floatToIntBits
method in class Float
,
and then writes that int
value to the file as a
4 or 2-byte quantity, high byte first.writeFloat
in class AbstractStream
v
- a float
value to be written.public void writeDouble(double v) throws java.io.IOException
long
using the
doubleToLongBits
method in class Double
,
and then writes that long
value to the file as an
8 or 4-byte quantity, high byte first.writeDouble
in class AbstractStream
v
- a double
value to be written.public void writeBytes(java.lang.String s) throws java.io.IOException
writeBytes
in class AbstractStream
s
- a string of bytes to be written.public void writeChars(java.lang.String s) throws java.io.IOException
writeChar
method.writeChars
in class AbstractStream
s
- a String
value to be written.public void writeUTF(java.lang.String str) throws java.io.IOException
writeUTF
in class AbstractStream
str
- a string to be written.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |