| CARVIEW |
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.io
Class OutputStream
java.lang.Objectjava.io.OutputStream
- Direct Known Subclasses:
- ByteArrayOutputStream, FileOutputStream, FilterOutputStream, ObjectOutputStream, OutputStream, PipedOutputStream
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,ByteArrayOutputStream,DataOutputStream,FilterOutputStream,InputStream,write(int)
| Constructor Summary | |
|---|---|
OutputStream()
|
|
| Method Summary | |
|---|---|
void |
close()
Closes this output stream and releases any system resources associated with this stream. |
void |
flush()
Flushes this output stream and forces any buffered output bytes to be written out. |
void |
write(byte[] b)
Writes b.length bytes from the specified byte array
to this output stream. |
void |
write(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(int b)
Writes the specified byte to this output stream. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
OutputStream
public OutputStream()
| Method Detail |
|---|
write
public abstract void write(int b)
throws IOException
- Writes the specified byte to this output stream. The general
contract for
writeis that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argumentb. The 24 high-order bits ofbare ignored.Subclasses of
OutputStreammust provide an implementation for this method.- Parameters:
b- thebyte.- Throws:
IOException- if an I/O error occurs. In particular, anIOExceptionmay be thrown if the output stream has been closed.
write
public void write(byte[] b)
throws IOException
- Writes
b.lengthbytes from the specified byte array to this output stream. The general contract forwrite(b)is that it should have exactly the same effect as the callwrite(b, 0, b.length).- Parameters:
b- the data.- Throws:
IOException- if an I/O error occurs.- See Also:
write(byte[], int, int)
write
public void write(byte[] b,
int off,
int len)
throws IOException
- Writes
lenbytes from the specified byte array starting at offsetoffto this output stream. The general contract forwrite(b, off, len)is that some of the bytes in the arraybare written to the output stream in order; elementb[off]is the first byte written andb[off+len-1]is the last byte written by this operation.The
writemethod ofOutputStreamcalls 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
bisnull, aNullPointerExceptionis thrown.If
offis negative, orlenis negative, oroff+lenis greater than the length of the arrayb, 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- if an I/O error occurs. In particular, anIOExceptionis thrown if the output stream is closed.
flush
public void flush()
throws IOException
- Flushes this output stream and forces any buffered output bytes
to be written out. The general contract of
flushis 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
flushmethod ofOutputStreamdoes nothing.- Throws:
IOException- if an I/O error occurs.
close
public void close()
throws IOException
- Closes this output stream and releases any system resources
associated with this stream. The general contract of
closeis that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.The
closemethod ofOutputStreamdoes nothing.- Throws:
IOException- if an I/O error occurs.
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.