org.mbari.io
Class AsciiHexReader

java.lang.Object
  java.io.Reader
      java.io.FilterReader
          org.mbari.io.AsciiHexReader

All Implemented Interfaces:

java.io.DataInput

public class AsciiHexReader

extends java.io.FilterReader

implements java.io.DataInput

Convert

Field Summary

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

AsciiHexReader(java.io.Reader in)

Method Summary

int	read() Read a single byte (2 ASCII characters).
boolean	readBoolean()
byte	readByte() Reads and returns one input byte.
char	readChar() Reads an input char and returns the char value.
double	readDouble() Reads eight input bytes and returns a double value.
float	readFloat() Reads four input bytes and returns a float value.
void	readFully(byte[] b) See the general contract of the readFully method of DataInput.
void	readFully(byte[] b, int off, int len) See the general contract of the readFully method of DataInput.
int	readInt() Reads four input bytes and returns an int value.
java.lang.String	readLine() Reads the next line of text from the input stream.
long	readLong() Reads eight input bytes and returns a long value.
short	readShort() Reads two input bytes and returns a short value.
int	readUnsignedByte() Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.
int	readUnsignedShort() Reads two input bytes and returns an int value in the range 0 through 65535.
java.lang.String	readUTF() Reads in a string that has been encoded using a modified UTF-8 format.
int	skipBytes(int n) See the general contract of the skipBytes method of DataInput.

Methods inherited from class java.io.FilterReader

close, mark, markSupported, read, ready, reset, skip

Methods inherited from class java.io.Reader

read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsciiHexReader

public AsciiHexReader(java.io.Reader in)

Method Detail

read

public int read()
         throws java.io.IOException

Read a single byte (2 ASCII characters).

Throws:

java.io.IOException - If an I/O error occurs

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Specified by:

readBoolean in interface java.io.DataInput

Throws:

java.io.IOException

readByte

public byte readByte()
              throws java.io.IOException

Reads and returns one input byte. The byte is treated as a signed value in the range -128 through 127, inclusive. This method is suitable for reading the byte written by the writeByte method of interface DataOutput.

Specified by:

readByte in interface java.io.DataInput

Returns:

the 8-bit value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readFully

public final void readFully(byte[] b)
                     throws java.io.IOException

See the general contract of the readFully method of DataInput.

Bytes for this operation are read from the contained input stream.

Specified by:

readFully in interface java.io.DataInput

Parameters:

b - the buffer into which the data is read.

Throws:

java.io.EOFException - if this input stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

See Also:

FilterInputStream.in

readFully

public final void readFully(byte[] b,
                            int off,
                            int len)
                     throws java.io.IOException

See the general contract of the readFully method of DataInput.

Bytes for this operation are read from the contained input stream.

Specified by:

readFully in interface java.io.DataInput

Parameters:

b - the buffer into which the data is read.

off - the start offset of the data.

len - the number of bytes to read.

Throws:

java.io.EOFException - if this input stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

See Also:

FilterInputStream.in

readUnsignedByte

public int readUnsignedByte()
                     throws java.io.IOException

Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. This method is suitable for reading the byte written by the writeByte method of interface DataOutput if the argument to writeByte was intended to be a value in the range 0 through 255.

Specified by:

readUnsignedByte in interface java.io.DataInput

Returns:

the unsigned 8-bit value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readShort

public short readShort()
                throws java.io.IOException

Reads two input bytes and returns a short value. Let a be the first byte read and b be the second byte. The value returned is:

(short)((a << 8) * | (b & 0xff))
 

This method is suitable for reading the bytes written by the writeShort method of interface DataOutput.

Specified by:

readShort in interface java.io.DataInput

Returns:

the 16-bit value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readUnsignedShort

public int readUnsignedShort()
                      throws java.io.IOException

Reads two input bytes and returns an int value in the range 0 through 65535. Let a be the first byte read and b be the second byte. The value returned is:

(((a & 0xff) << 8) | (b & 0xff))
 

This method is suitable for reading the bytes written by the writeShort method of interface DataOutput if the argument to writeShort was intended to be a value in the range 0 through 65535.

Specified by:

readUnsignedShort in interface java.io.DataInput

Returns:

the unsigned 16-bit value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readChar

public char readChar()
              throws java.io.IOException

Reads an input char and returns the char value. A Unicode char is made up of two bytes. Let a be the first byte read and b be the second byte. The value returned is:

(char)((a << 8) | (b & 0xff))
 

This method is suitable for reading bytes written by the writeChar method of interface DataOutput.

Specified by:

readChar in interface java.io.DataInput

Returns:

the Unicode char read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readInt

public int readInt()
            throws java.io.IOException

Reads four input bytes and returns an int value. Let a be the first byte read, b be the second byte, c be the third byte, and d be the fourth byte. The value returned is:

 
 (((a & 0xff) << 24) | ((b & 0xff) << 16) |
  ((c & 0xff) << 8) | (d & 0xff))
 

This method is suitable for reading bytes written by the writeInt method of interface DataOutput.

Specified by:

readInt in interface java.io.DataInput

Returns:

the int value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readLong

public long readLong()
              throws java.io.IOException

Reads eight input bytes and returns a long value. Let a be the first byte read, b be the second byte, c be the third byte, d be the fourth byte, e be the fifth byte, f be the sixth byte, g be the seventh byte, and h be the eighth byte. The value returned is:

 
 (((long)(a & 0xff) << 56) |
  ((long)(b & 0xff) << 48) |
  ((long)(c & 0xff) << 40) |
  ((long)(d & 0xff) << 32) |
  ((long)(e & 0xff) << 24) |
  ((long)(f & 0xff) << 16) |
  ((long)(g & 0xff) <<  8) |
  ((long)(h & 0xff)))
 

This method is suitable for reading bytes written by the writeLong method of interface DataOutput.

Specified by:

readLong in interface java.io.DataInput

Returns:

the long value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readFloat

public float readFloat()
                throws java.io.IOException

Reads four input bytes and returns a float value. It does this by first constructing an int value in exactly the manner of the readInt method, then converting this int value to a float in exactly the manner of the method Float.intBitsToFloat. This method is suitable for reading bytes written by the writeFloat method of interface DataOutput.

Specified by:

readFloat in interface java.io.DataInput

Returns:

the float value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readDouble

public double readDouble()
                  throws java.io.IOException

Reads eight input bytes and returns a double value. It does this by first constructing a long value in exactly the manner of the readlong method, then converting this long value to a double in exactly the manner of the method Double.longBitsToDouble. This method is suitable for reading bytes written by the writeDouble method of interface DataOutput.

Specified by:

readDouble in interface java.io.DataInput

Returns:

the double value read.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Reads the next line of text from the input stream. It reads successive bytes, converting each byte separately into a character, until it encounters a line terminator or end of file; the characters read are then returned as a String. Note that because this method processes bytes, it does not support input of the full Unicode character set.

If end of file is encountered before even one byte can be read, then null is returned. Otherwise, each byte that is read is converted to type char by zero-extension. If the character '\n' is encountered, it is discarded and reading ceases. If the character '\r' is encountered, it is discarded and, if the following byte converts to the character '\n', then that is discarded also; reading then ceases. If end of file is encountered before either of the characters '\n' and '\r' is encountered, reading ceases. Once reading has ceased, a String is returned that contains all the characters read and not discarded, taken in order. Note that every character in this string will have a value less than \u0100, that is, (char)256.

Specified by:

readLine in interface java.io.DataInput

Returns:

if this stream reaches the end before reading all the bytes.

Throws:

java.io.IOException - if an I/O error occurs.

readUTF

public java.lang.String readUTF()
                         throws java.io.IOException

Reads in a string that has been encoded using a modified UTF-8 format. The general contract of readUTF is that it reads a representation of a Unicode character string encoded in Java modified UTF-8 format; this string of characters is then returned as a String.

First, two bytes are read and used to construct an unsigned 16-bit integer in exactly the manner of the readUnsignedShort method . This integer value is called the UTF length and specifies the number of additional bytes to be read. These bytes are then converted to characters by considering them in groups. The length of each group is computed from the value of the first byte of the group. The byte following a group, if any, is the first byte of the next group.

If the first byte of a group matches the bit pattern 0xxxxxxx (where x means "may be 0 or 1"), then the group consists of just that byte. The byte is zero-extended to form a character.

If the first byte of a group matches the bit pattern 110xxxxx, then the group consists of that byte a and a second byte b. If there is no byte b (because byte a was the last of the bytes to be read), or if byte b does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:

(char)(((a& 0x1F) << 6) | (b & 0x3F))
 

If the first byte of a group matches the bit pattern 1110xxxx, then the group consists of that byte a and two more bytes b and c. If there is no byte c (because byte a was one of the last two of the bytes to be read), or either byte b or byte c does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:

 (char)(((a & 0x0F) << 12) | ((b & 0x3F) << 6) | (c & 0x3F))
 

If the first byte of a group matches the pattern 1111xxxx or the pattern 10xxxxxx, then a UTFDataFormatException is thrown.

If end of file is encountered at any time during this entire process, then an EOFException is thrown.

After every group has been converted to a character by this process, the characters are gathered, in the same order in which their corresponding groups were read from the input stream, to form a String, which is returned.

The writeUTF method of interface DataOutput may be used to write data that is suitable for reading by this method.

Specified by:

readUTF in interface java.io.DataInput

Returns:

a Unicode string.

Throws:

java.io.EOFException - if this stream reaches the end before reading all the bytes.

java.io.IOException - if an I/O error occurs.

java.io.UTFDataFormatException - if the bytes do not represent a valid UTF-8 encoding of a string.

skipBytes

public final int skipBytes(int n)
                    throws java.io.IOException

See the general contract of the skipBytes method of DataInput.

Bytes for this operation are read from the contained input stream.

Specified by:

skipBytes in interface java.io.DataInput

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

Throws:

java.io.IOException - if an I/O error occurs.