Package org.apache.juneau.rest.util

Class FinishableServletOutputStream

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

org.apache.juneau.rest.util.FinishableServletOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Finishable

public class FinishableServletOutputStream
extends jakarta.servlet.ServletOutputStream
implements Finishable

A wrapped ServletOutputStream with an added finish() method.

See Also:

Constructor Summary

Constructors

Constructor	Description
FinishableServletOutputStream(OutputStream os)	Constructor.

Method Summary

Modifier and Type	Method	Description
final void	close()
void	finish()	Calls Finishable.finish() on the underlying output stream.
final void	flush()
boolean	isReady()
void	setWriteListener(jakarta.servlet.WriteListener arg0)
final void	write(byte[] b, int off, int len)
final void	write(int b)

Methods inherited from class jakarta.servlet.ServletOutputStream

print, print, print, print, print, print, print, println, println, println, println, println, println, println, println

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FinishableServletOutputStream

public FinishableServletOutputStream(OutputStream os)

Constructor.

Parameters:

os - The wrapped output stream.

Method Details

write

public final void write(byte[] b,
 int off,
 int len)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public final void write(int b)
                 throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public final void close()
                 throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

isReady

public boolean isReady()

Specified by:

isReady in class jakarta.servlet.ServletOutputStream

setWriteListener

public void setWriteListener(jakarta.servlet.WriteListener arg0)

Specified by:

setWriteListener in class jakarta.servlet.ServletOutputStream

finish

public void finish()
            throws IOException

Calls Finishable.finish() on the underlying output stream.

A no-op if the underlying output stream does not implement the Finishable interface.

Specified by:

finish in interface Finishable

Throws:

IOException - Thrown by underlying stream.