|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.OutputStream
javax.servlet.ServletOutputStream
org.apache.sling.engine.impl.output.BufferedServletOutputStream
public class BufferedServletOutputStream
The BufferedServletOutputStream
is a wrapper for
OutputStream
objects, which do not have their own
buffering support. The main use of this class is to wrap the output stream
retrieved from the cache handler, which does not have buffering but buffering
needs to be supported.
This class is not multithread safe as it is intended to be used on single requests which are assigned to single threads.
Field Summary | |
---|---|
protected boolean |
closed
flag to indicate that the stream has been closed |
protected OutputStream |
delegatee
The wrapped ServletOutputStream |
Constructor Summary | |
---|---|
BufferedServletOutputStream(OutputStream delegatee,
int bufferSize)
Creates an instance wrapping the OutputStream and
providing an initial buffer bufferSize. |
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 |
flushBuffer()
Flushes the output buffer to the underlying ServletOutputStream . |
int |
getBufferSize()
Returns the size of the buffer |
void |
resetBuffer()
CLears the buffer. |
void |
setBufferSize(int bufferSize)
Sets the buffer size. |
void |
write(byte[] b,
int off,
int len)
Writes len bytes from the specified byte array
starting at offset off to this output stream. |
void |
write(int b)
Writes the specified byte to this output stream. |
Methods inherited from class javax.servlet.ServletOutputStream |
---|
print, print, print, print, print, print, print, println, println, println, println, println, println, println, println |
Methods inherited from class java.io.OutputStream |
---|
write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected OutputStream delegatee
ServletOutputStream
protected boolean closed
Constructor Detail |
---|
public BufferedServletOutputStream(OutputStream delegatee, int bufferSize)
OutputStream
and
providing an initial buffer bufferSize.
delegatee
- The OutputStream
to wrap with bufferingbufferSize
- The initial buffer bufferSize in bytesMethod Detail |
---|
public void setBufferSize(int bufferSize)
setBufferSize
in interface Buffer
bufferSize
-
IllegalStateException
- if the buffer contains data.public int getBufferSize()
getBufferSize
in interface Buffer
public void resetBuffer()
resetBuffer
in interface Buffer
public void flushBuffer() throws IOException
ServletOutputStream
.
flushBuffer
in interface Buffer
IOException
- If the stream is already closed or if an I/O error
occurrs flushing the buffer.public void flush() throws IOException
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.
The flush
method of OutputStream
does nothing.
flush
in interface Flushable
flush
in class OutputStream
IOException
- if an I/O error occurs.public void close() throws IOException
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.
close
in interface Closeable
close
in class OutputStream
IOException
- if an I/O error occurs.public void write(int b) throws IOException
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.
write
in class OutputStream
b
- the byte
.
IOException
- if an I/O error occurs. In particular,
an IOException
may be thrown if the
output stream has been closed.public void write(byte[] b, int off, int len) throws IOException
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.
write
in class OutputStream
b
- the data.off
- the start offset in the data.len
- the number of bytes to write.
IOException
- if an I/O error occurs. In particular,
an IOException
is thrown if the output
stream is closed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |