Module cloud.piranha.core.api

Package cloud.piranha.core.api

Class WebApplicationOutputStream

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

cloud.piranha.core.api.WebApplicationOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

DefaultWebApplicationOutputStream

public abstract class WebApplicationOutputStream
extends jakarta.servlet.ServletOutputStream

The WebApplicationOutputStream API.

Author:

Manfred Riem ([email protected])

Constructor Summary

Constructors

Constructor	Description
WebApplicationOutputStream()

Method Summary

Modifier and Type	Method	Description
abstract void	flushBuffer()	Flush the buffer.
abstract int	getBufferSize()	Get the buffer size.
abstract OutputStream	getOutputStream()	Get the output stream.
abstract WebApplicationResponse	getResponse()	Get the web application response.
abstract void	resetBuffer()	Reset the buffer.
abstract void	setBufferSize(int bufferSize)	Set the buffer size.
abstract void	setOutputStream(OutputStream outputStream)	Set the output stream.
abstract void	setResponse(WebApplicationResponse response)	Set the web application response.

Methods inherited from class jakarta.servlet.ServletOutputStream

isReady, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, setWriteListener

Methods inherited from class java.io.OutputStream

close, flush, nullOutputStream, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

WebApplicationOutputStream

public WebApplicationOutputStream()

Method Details

flushBuffer

public abstract void flushBuffer()
                          throws IOException

Flush the buffer.

Throws:

IOException - when an I/O error occurs.

getBufferSize

public abstract int getBufferSize()

Get the buffer size.

Returns:

the buffer size.

getOutputStream

public abstract OutputStream getOutputStream()

Get the output stream.

Returns:

the output stream.

getResponse

public abstract WebApplicationResponse getResponse()

Get the web application response.

Returns:

the web application response.

resetBuffer

public abstract void resetBuffer()

Reset the buffer.

setBufferSize

public abstract void setBufferSize(int bufferSize)

Set the buffer size.

Parameters:

bufferSize - the buffer size.

setOutputStream

public abstract void setOutputStream(OutputStream outputStream)

Set the output stream.

Parameters:

outputStream - the output stream.

setResponse

public abstract void setResponse(WebApplicationResponse response)

Set the web application response.

Parameters:

response - the web application response.