Home » openjdk-7 » java » io » [javadoc | source]
java.io
public class: DataOutputStream [javadoc | source]
java.lang.Object
   java.io.OutputStream
      java.io.FilterOutputStream
         java.io.DataOutputStream

All Implemented Interfaces:
    DataOutput, Flushable, Closeable

A data output stream lets an application write primitive Java data types to an output stream in a portable way. An application can then use a data input stream to read the data back in.
Field Summary
protected  int written    The number of bytes written to the data output stream so far. If this counter overflows, it will be wrapped to Integer.MAX_VALUE. 
Fields inherited from java.io.FilterOutputStream:
out
Constructor:
 public DataOutputStream(OutputStream out) 
    Creates a new data output stream to write data to the specified underlying output stream. The counter written is set to zero.
    Parameters:
    out - the underlying output stream, to be saved for later use.
    Also see:
    java.io.FilterOutputStream#out
Method from java.io.DataOutputStream Summary:
flush,   size,   write,   write,   writeBoolean,   writeByte,   writeBytes,   writeChar,   writeChars,   writeDouble,   writeFloat,   writeInt,   writeLong,   writeShort,   writeUTF,   writeUTF
Methods from java.io.FilterOutputStream:
close,   flush,   write,   write,   write
Methods from java.io.OutputStream:
close,   flush,   write,   write,   write
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.DataOutputStream Detail:
 public  void flush() throws IOException 
    Flushes this data output stream. This forces any buffered output bytes to be written out to the stream.

    The flush method of DataOutputStream calls the flush method of its underlying output stream.

 public final int size() 
    Returns the current value of the counter written, the number of bytes written to this data output stream so far. If the counter overflows, it will be wrapped to Integer.MAX_VALUE.
 public synchronized  void write(int b) throws IOException 
    Writes the specified byte (the low eight bits of the argument b) to the underlying output stream. If no exception is thrown, the counter written is incremented by 1.

    Implements the write method of OutputStream.

 public synchronized  void write(byte[] b,
    int off,
    int len) throws IOException 
    Writes len bytes from the specified byte array starting at offset off to the underlying output stream. If no exception is thrown, the counter written is incremented by len.
 public final  void writeBoolean(boolean v) throws IOException 
    Writes a boolean to the underlying output stream 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. If no exception is thrown, the counter written is incremented by 1.
 public final  void writeByte(int v) throws IOException 
    Writes out a byte to the underlying output stream as a 1-byte value. If no exception is thrown, the counter written is incremented by 1.
 public final  void writeBytes(String s) throws IOException 
    Writes out the string to the underlying output stream as a sequence of bytes. Each character in the string is written out, in sequence, by discarding its high eight bits. If no exception is thrown, the counter written is incremented by the length of s.
 public final  void writeChar(int v) throws IOException 
    Writes a char to the underlying output stream as a 2-byte value, high byte first. If no exception is thrown, the counter written is incremented by 2.
 public final  void writeChars(String s) throws IOException 
    Writes a string to the underlying output stream as a sequence of characters. Each character is written to the data output stream as if by the writeChar method. If no exception is thrown, the counter written is incremented by twice the length of s.
 public final  void writeDouble(double v) throws IOException 
    Converts the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the underlying output stream as an 8-byte quantity, high byte first. If no exception is thrown, the counter written is incremented by 8.
 public final  void writeFloat(float v) throws IOException 
    Converts the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the underlying output stream as a 4-byte quantity, high byte first. If no exception is thrown, the counter written is incremented by 4.
 public final  void writeInt(int v) throws IOException 
    Writes an int to the underlying output stream as four bytes, high byte first. If no exception is thrown, the counter written is incremented by 4.
 public final  void writeLong(long v) throws IOException 
    Writes a long to the underlying output stream as eight bytes, high byte first. In no exception is thrown, the counter written is incremented by 8.
 public final  void writeShort(int v) throws IOException 
    Writes a short to the underlying output stream as two bytes, high byte first. If no exception is thrown, the counter written is incremented by 2.
 public final  void writeUTF(String str) throws IOException 
    Writes a string to the underlying output stream using modified UTF-8 encoding in a machine-independent manner.

    First, two bytes are written to the output stream as if by the 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 modified UTF-8 encoding for the character. If no exception is thrown, the counter written is incremented by the total number of bytes written to the output stream. This will be at least two plus the length of str, and at most two plus thrice the length of str.

 static int writeUTF(String str,
    DataOutput out) throws IOException 
    Writes a string to the specified DataOutput using modified UTF-8 encoding in a machine-independent manner.

    First, two bytes are written to out as if by the 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 modified UTF-8 encoding for the character. If no exception is thrown, the counter written is incremented by the total number of bytes written to the output stream. This will be at least two plus the length of str, and at most two plus thrice the length of str.