java.io
Class OutputStream

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.io.OutputStream
All Implemented Interfaces:
Closeable sample code for java.io.Closeable definition code for java.io.Closeable , Flushable sample code for java.io.Flushable definition code for java.io.Flushable
Direct Known Subclasses:
ByteArrayOutputStream sample code for java.io.ByteArrayOutputStream definition code for java.io.ByteArrayOutputStream , FileOutputStream sample code for java.io.FileOutputStream definition code for java.io.FileOutputStream , FilterOutputStream sample code for java.io.FilterOutputStream definition code for java.io.FilterOutputStream , ObjectOutputStream sample code for java.io.ObjectOutputStream definition code for java.io.ObjectOutputStream , OutputStream sample code for org.omg.CORBA.portable.OutputStream definition code for org.omg.CORBA.portable.OutputStream , PipedOutputStream sample code for java.io.PipedOutputStream definition code for java.io.PipedOutputStream

public abstract class OutputStream
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Closeable sample code for java.io.Closeable definition code for java.io.Closeable , Flushable sample code for java.io.Flushable definition code for java.io.Flushable

This abstract class is the superclass of all classes representing an output stream of bytes. An output stream accepts output bytes and sends them to some sink.

Applications that need to define a subclass of OutputStream must always provide at least a method that writes one byte of output.

Since:
JDK1.0
See Also:
BufferedOutputStream sample code for java.io.BufferedOutputStream definition code for java.io.BufferedOutputStream , ByteArrayOutputStream sample code for java.io.ByteArrayOutputStream definition code for java.io.ByteArrayOutputStream , DataOutputStream sample code for java.io.DataOutputStream definition code for java.io.DataOutputStream , FilterOutputStream sample code for java.io.FilterOutputStream definition code for java.io.FilterOutputStream , InputStream sample code for java.io.InputStream definition code for java.io.InputStream , write(int) sample code for java.io.OutputStream.write(int) definition code for java.io.OutputStream.write(int)

Constructor Summary
OutputStream sample code for java.io.OutputStream.OutputStream() definition code for java.io.OutputStream.OutputStream() ()
           
 
Method Summary
 void close sample code for java.io.OutputStream.close() definition code for java.io.OutputStream.close() ()
          Closes this output stream and releases any system resources associated with this stream.
 void flush sample code for java.io.OutputStream.flush() definition code for java.io.OutputStream.flush() ()
          Flushes this output stream and forces any buffered output bytes to be written out.
 void write sample code for java.io.OutputStream.write(byte[]) definition code for java.io.OutputStream.write(byte[]) (byte[] b)
          Writes b.length bytes from the specified byte array to this output stream.
 void write sample code for java.io.OutputStream.write(byte[], int, int) definition code for java.io.OutputStream.write(byte[], int, int) (byte[] b, int off, int len)
          Writes len bytes from the specified byte array starting at offset off to this output stream.
abstract  void write sample code for java.io.OutputStream.write(int) definition code for java.io.OutputStream.write(int) (int b)
          Writes the specified byte to this output stream.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

OutputStream sample code for java.io.OutputStream() definition code for java.io.OutputStream()

public OutputStream()
Method Detail

write sample code for java.io.OutputStream.write(int) definition code for java.io.OutputStream.write(int)

public abstract void write(int b)
                    throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Subclasses of OutputStream must provide an implementation for this method.

Parameters:
b - the byte.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write sample code for java.io.OutputStream.write(byte[]) definition code for java.io.OutputStream.write(byte[])

public void write(byte[] b)
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters:
b - the data.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
write(byte[], int, int) sample code for java.io.OutputStream.write(byte[], int, int) definition code for java.io.OutputStream.write(byte[], int, int)

write sample code for java.io.OutputStream.write(byte[], int, int) definition code for java.io.OutputStream.write(byte[], int, int)

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters:
b - the data.
off - the start offset in the data.
len - the number of bytes to write.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

flush sample code for java.io.OutputStream.flush() definition code for java.io.OutputStream.flush()

public void flush()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

The flush method of OutputStream does nothing.

Specified by:
flush sample code for java.io.Flushable.flush() definition code for java.io.Flushable.flush() in interface Flushable sample code for java.io.Flushable definition code for java.io.Flushable
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

close sample code for java.io.OutputStream.close() definition code for java.io.OutputStream.close()

public void close()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

The close method of OutputStream does nothing.

Specified by:
close sample code for java.io.Closeable.close() definition code for java.io.Closeable.close() in interface Closeable sample code for java.io.Closeable definition code for java.io.Closeable
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.