ewe.io
Class DataOutputStream

java.lang.Object
  extended byewe.io.OutputStream
      extended byewe.io.FilterOutputStream
          extended byewe.io.DataOutputStream
All Implemented Interfaces:
DataOutput, Streamable

public class DataOutputStream
extends FilterOutputStream
implements DataOutput


Field Summary
protected  byte[] buffer
           
 boolean closeUnderlying
          Set this to false if you don't want a close of this DataOutputStream to close the underlying Stream.
protected  Lock lock
           
protected  int written
          The number of bytes written to the Stream.
 
Fields inherited from class ewe.io.OutputStream
closed, out, rs, stream
 
Constructor Summary
DataOutputStream(OutputStream s)
           
DataOutputStream(Stream s)
           
 
Method Summary
 void close()
           
 int size()
          Returns the number of bytes written to the Stream.
 void write(byte[] bytes)
          This method writes the raw byte array passed in to the output stream.
 void write(byte[] bytes, int offset, int length)
          This method writes raw bytes from the passed array buf starting offset bytes into the buffer.
 void write(int aByte)
          This method writes an 8-bit value (passed into the method as a Java int) to an output stream.
 void writeBoolean(boolean value)
          This method writes a Java boolean value to an output stream.
 void writeByte(int value)
          This method writes a Java byte value to an output stream.
 void writeBytes(String text)
          This method writes all the bytes in a String out to the stream.
 void writeChar(int aCharacter)
          This method writes a Java char value to an output stream.
 void writeChars(String value)
          This method writes all the characters of a String to an output stream as an array of char's.
 void writeDouble(double value)
          This method writes a Java double value to the stream.
 void writeFloat(float value)
          This method writes a Java float value to the stream.
 void writeInt(int value)
          This method writes a Java int value to an output stream.
protected  void writeIntBytes(int value, int numBytes)
           
 void writeLong(long value)
          This method writes a Java long value to an output stream.
 void writeShort(int value)
          This method writes a Java short value to an output stream.
 void writeUTF(String value)
          This method writes a Java String to the stream in a modified UTF-8 format.
 
Methods inherited from class ewe.io.OutputStream
flush, getFastStream, getName, shutdown, toStream, toWritableStream, writeSingleByteToMultiByteWrite
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, toString
 

Field Detail

closeUnderlying

public boolean closeUnderlying
Set this to false if you don't want a close of this DataOutputStream to close the underlying Stream.


written

protected int written
The number of bytes written to the Stream.


buffer

protected byte[] buffer

lock

protected Lock lock
Constructor Detail

DataOutputStream

public DataOutputStream(Stream s)

DataOutputStream

public DataOutputStream(OutputStream s)
Method Detail

size

public int size()
Returns the number of bytes written to the Stream.


close

public void close()
           throws IOException
Overrides:
close in class OutputStream
Throws:
IOException

write

public void write(byte[] bytes,
                  int offset,
                  int length)
           throws IOException
Description copied from interface: DataOutput
This method writes raw bytes from the passed array buf starting offset bytes into the buffer. The number of bytes written will be exactly len.

Specified by:
write in interface DataOutput
Overrides:
write in class OutputStream
Parameters:
bytes - the source buffer for the data.
offset - The start offset in the buffer.
length - The number of bytes to write.
Throws:
IOException - if an I/O error occurs during writing.

write

public void write(int aByte)
           throws IOException
Description copied from interface: DataOutput
This method writes an 8-bit value (passed into the method as a Java int) to an output stream. The low 8 bits of the passed value are written.

Specified by:
write in interface DataOutput
Overrides:
write in class OutputStream
Throws:
IOException - if an I/O error occured.

write

public void write(byte[] bytes)
           throws IOException
Description copied from interface: DataOutput
This method writes the raw byte array passed in to the output stream.

Specified by:
write in interface DataOutput
Overrides:
write in class OutputStream
Parameters:
bytes - the source buffer for the data.
Returns:
the total number of bytes written from the buffer - which is always equal to the length of the buffer.
Throws:
IOException - if an I/O error occurs during writing.

writeIntBytes

protected void writeIntBytes(int value,
                             int numBytes)
                      throws IOException
Throws:
IOException

writeBytes

public void writeBytes(String text)
                throws IOException
Description copied from interface: DataOutput
This method writes all the bytes in a String out to the stream. One byte is written for each character in the String. The high eight bits of each character are discarded, thus this method is inappropriate for completely representing Unicode characters.

Specified by:
writeBytes in interface DataOutput
Parameters:
text - The String to write
Throws:
IOException - If an error occurs

writeByte

public void writeByte(int value)
               throws IOException
Description copied from interface: DataOutput
This method writes a Java byte value to an output stream. The byte to be written will be in the lowest 8 bits of the int value passed. The value written can be read using the readByte or readUnsignedByte methods in DataInput.

Specified by:
writeByte in interface DataOutput
Parameters:
value - The int value to write
Throws:
IOException - If an error occurs
See Also:
DataInput.readByte(), DataInput.readUnsignedByte()

writeChar

public void writeChar(int aCharacter)
               throws IOException
Description copied from interface: DataOutput
This method writes a Java char value to an output stream. The char to be written will be in the lowest 16 bits of the int value passed. These bytes will be written "big endian". That is, with the high byte written first in the following manner:

byte0 = (byte)((value & 0xFF00) >> 8);
byte1 = (byte)(value & 0x00FF);

The value written can be read using the readChar method in DataInput.

Specified by:
writeChar in interface DataOutput
Parameters:
aCharacter - The char value to write
Throws:
IOException - If an error occurs
See Also:
DataInput.readChar()

writeShort

public void writeShort(int value)
                throws IOException
Description copied from interface: DataOutput
This method writes a Java short value to an output stream. The char to be written will be in the lowest 16 bits of the int value passed. These bytes will be written "big endian". That is, with the high byte written first in the following manner:

byte0 = (byte)((value & 0xFF00) >> 8);
byte1 = (byte)(value & 0x00FF);

The value written can be read using the readShort and readUnsignedShort methods in DataInput.

Specified by:
writeShort in interface DataOutput
Parameters:
value - The int value to write as a 16-bit value
Throws:
IOException - If an error occurs
See Also:
DataInput.readShort(), DataInput.readUnsignedShort()

writeInt

public void writeInt(int value)
              throws IOException
Description copied from interface: DataOutput
This method writes a Java int value to an output stream. The 4 bytes of the passed value will be written "big endian". That is, with the high byte written first in the following manner:

byte0 = (byte)((value & 0xFF000000) >> 24);
byte1 = (byte)((value & 0x00FF0000) >> 16);
byte2 = (byte)((value & 0x0000FF00) >> 8);
byte3 = (byte)(value & 0x000000FF);

The value written can be read using the readInt method in DataInput.

Specified by:
writeInt in interface DataOutput
Parameters:
value - The int value to write
Throws:
IOException - If an error occurs
See Also:
DataInput.readInt()

writeBoolean

public final void writeBoolean(boolean value)
                        throws IOException
This method writes a Java boolean value to an output stream. If value is true, a byte with the value of 1 will be written, otherwise a byte with the value of 0 will be written. The value written can be read using the readBoolean method in DataInput.

Specified by:
writeBoolean in interface DataOutput
Parameters:
value - The boolean value to write to the stream
Throws:
IOException - If an error occurs
See Also:
DataInput.readBoolean()

writeLong

public void writeLong(long value)
               throws IOException
This method writes a Java long value to an output stream. The 8 bytes of the passed value will be written "big endian". That is, with the high byte written first in the following manner:

byte0 = (byte)((value & 0xFF00000000000000L) >> 56);
byte1 = (byte)((value & 0x00FF000000000000L) >> 48);
byte2 = (byte)((value & 0x0000FF0000000000L) >> 40);
byte3 = (byte)((value & 0x000000FF00000000L) >> 32);
byte4 = (byte)((value & 0x00000000FF000000L) >> 24);
byte5 = (byte)((value & 0x0000000000FF0000L) >> 16);
byte6 = (byte)((value & 0x000000000000FF00L) >> 8);
byte7 = (byte)(value & 0x00000000000000FFL);

The value written can be read using the readLong method in DataInput.

Specified by:
writeLong in interface DataOutput
Parameters:
value - The long value to write to the stream
Throws:
IOException - If an error occurs
See Also:
DataInput.readLong()

writeFloat

public final void writeFloat(float value)
                      throws IOException
This method writes a Java float value to the stream. This value is written by first calling the method Float.floatToIntBits to retrieve an int representing the floating point number, then writing this int value to the stream exactly the same as the writeInt() method does. The value written can be read using the readFloat method in DataInput.

Specified by:
writeFloat in interface DataOutput
Parameters:
value - The float value to write to the stream
Throws:
IOException - If an error occurs
See Also:
writeInt, DataInput.readFloat(), Float.floatToIntBits(float)

writeDouble

public void writeDouble(double value)
                 throws IOException
This method writes a Java double value to the stream. This value is written by first calling the method Double.doubleToLongBits to retrieve an long representing the floating point number, then writing this long value to the stream exactly the same as the writeLong() method does. The value written can be read using the readDouble method in DataInput.

Specified by:
writeDouble in interface DataOutput
Parameters:
value - The double value to write to the stream
Throws:
IOException - If an error occurs
See Also:
writeLong, DataInput.readDouble(), Double.doubleToLongBits(double)

writeChars

public void writeChars(String value)
                throws IOException
This method writes all the characters of a String to an output stream as an array of char's. Each character is written using the method specified in the writeChar method.

Specified by:
writeChars in interface DataOutput
Parameters:
value - The String to write to the stream
Throws:
IOException - If an error occurs
See Also:
writeChar

writeUTF

public final void writeUTF(String value)
                    throws IOException
This method writes a Java String to the stream in a modified UTF-8 format. First, two bytes are written to the stream indicating the number of bytes to follow. Note that this is the number of bytes in the encoded String not the String length. Next come the encoded characters. Each character in the String is encoded as either one, two or three bytes. For characters in the range of  to <>, one byte is used. The character value goes into bits 0-7 and bit eight is 0. For characters in the range of ? to F, two bytes are used. Bits 6-10 of the character value are encoded bits 0-4 of the first byte, with the high bytes having a value of "110". Bits 0-5 of the character value are stored in bits 0-5 of the second byte, with the high bits set to "10". This type of encoding is also done for the null character . This eliminates any C style NUL character values in the output. All remaining characters are stored as three bytes. Bits 12-15 of the character value are stored in bits 0-3 of the first byte. The high bits of the first bytes are set to "1110". Bits 6-11 of the character value are stored in bits 0-5 of the second byte. The high bits of the second byte are set to "10". And bits 0-5 of the character value are stored in bits 0-5 of byte three, with the high bits of that byte set to "10". The value written can be read using the readUTF method in DataInput.

Specified by:
writeUTF in interface DataOutput
Parameters:
value - The String to write to the output in UTF format
Throws:
IOException - If an error occurs
See Also:
DataInput.readUTF()