Module cloud.piranha.core.impl

Package cloud.piranha.core.impl

Class DefaultWebApplicationOutputStream

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

cloud.piranha.core.api.WebApplicationOutputStream

cloud.piranha.core.impl.DefaultWebApplicationOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class DefaultWebApplicationOutputStream
extends WebApplicationOutputStream

The default WebApplicationOutputStream.

Author:

Manfred Riem ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	buffer	Stores the buffer.
protected int	index	Stores the index.
protected OutputStream	outputStream	Stores the output stream.
protected WebApplicationResponse	response	Stores the web application response.

Constructor Summary

Constructors

Constructor	Description
DefaultWebApplicationOutputStream()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
void	flushBuffer()	Flush the buffer.
int	getBufferSize()	Get the buffer size.
OutputStream	getOutputStream()	Get the output stream.
WebApplicationResponse	getResponse()	Get the web application response.
boolean	isReady()
void	resetBuffer()	Reset the buffer.
void	setBufferSize(int bufferSize)	Set the buffer size.
void	setOutputStream(OutputStream outputStream)	Set the output stream.
void	setResponse(WebApplicationResponse response)	Set the web application response.
void	setWriteListener(jakarta.servlet.WriteListener listener)
void	write(int integer)

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, write

Methods inherited from class java.lang.Object

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

Field Details

buffer

protected byte[] buffer

Stores the buffer.

index

protected int index

Stores the index.

response

protected WebApplicationResponse response

Stores the web application response.

outputStream

protected OutputStream outputStream

Stores the output stream.

Constructor Details

DefaultWebApplicationOutputStream

public DefaultWebApplicationOutputStream()

Constructor.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

flushBuffer

public void flushBuffer()
                 throws IOException

Flush the buffer.

This will cause the following to be written out in order:

1. the status line
2. the response headers
3. the buffer (aka the response body)

Specified by:

flushBuffer in class WebApplicationOutputStream

Throws:

IOException - when an I/O error occurs.

getBufferSize

public int getBufferSize()

Description copied from class: WebApplicationOutputStream

Get the buffer size.

Specified by:

getBufferSize in class WebApplicationOutputStream

Returns:

the buffer size.

getOutputStream

public OutputStream getOutputStream()

Description copied from class: WebApplicationOutputStream

Get the output stream.

Specified by:

getOutputStream in class WebApplicationOutputStream

Returns:

the output stream.

getResponse

public WebApplicationResponse getResponse()

Description copied from class: WebApplicationOutputStream

Get the web application response.

Specified by:

getResponse in class WebApplicationOutputStream

Returns:

the web application response.

isReady

public boolean isReady()

Specified by:

isReady in class jakarta.servlet.ServletOutputStream

resetBuffer

public void resetBuffer()

Description copied from class: WebApplicationOutputStream

Reset the buffer.

Specified by:

resetBuffer in class WebApplicationOutputStream

setBufferSize

public void setBufferSize(int bufferSize)

Description copied from class: WebApplicationOutputStream

Set the buffer size.

Specified by:

setBufferSize in class WebApplicationOutputStream

Parameters:

bufferSize - the buffer size.

setOutputStream

public void setOutputStream(OutputStream outputStream)

Description copied from class: WebApplicationOutputStream

Set the output stream.

Specified by:

setOutputStream in class WebApplicationOutputStream

Parameters:

outputStream - the output stream.

setResponse

public void setResponse(WebApplicationResponse response)

Description copied from class: WebApplicationOutputStream

Set the web application response.

Specified by:

setResponse in class WebApplicationOutputStream

Parameters:

response - the web application response.

setWriteListener

public void setWriteListener(jakarta.servlet.WriteListener listener)

Specified by:

setWriteListener in class jakarta.servlet.ServletOutputStream

write

public void write(int integer)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException