org.springframework.mock.web

Class DelegatingServletOutputStream

java.lang.Object

java.io.OutputStream

javax.servlet.ServletOutputStream

org.springframework.mock.web.DelegatingServletOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class DelegatingServletOutputStream
extends ServletOutputStream

Delegating implementation of ServletOutputStream.

Used by MockHttpServletResponse; typically not directly used for testing application controllers.

Since:

1.0.2

Author:

Juergen Hoeller

See Also:

MockHttpServletResponse

Constructor Summary

Constructors

Constructor and Description
DelegatingServletOutputStream(OutputStream targetStream) Create a DelegatingServletOutputStream for the given target stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
OutputStream	getTargetStream() Return the underlying target stream (never null).
boolean	isReady() This method can be used to determine if data can be written without blocking.
void	setWriteListener(WriteListener writeListener) Instructs the ServletOutputStream to invoke the provided WriteListener when it is possible to write
void	write(int b)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingServletOutputStream

public DelegatingServletOutputStream(OutputStream targetStream)

Create a DelegatingServletOutputStream for the given target stream.

Parameters:

targetStream - the target stream (never null)

Method Detail

getTargetStream

public final OutputStream getTargetStream()

Return the underlying target stream (never null).

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

isReady

public boolean isReady()

Description copied from class: javax.servlet.ServletOutputStream

This method can be used to determine if data can be written without blocking.

Specified by:

isReady in class ServletOutputStream

Returns:

true if a write to this ServletOutputStream will succeed, otherwise returns false.

setWriteListener

public void setWriteListener(WriteListener writeListener)

Description copied from class: javax.servlet.ServletOutputStream

Instructs the ServletOutputStream to invoke the provided WriteListener when it is possible to write

Specified by:

setWriteListener in class ServletOutputStream

Parameters:

writeListener - the WriteListener that should be notified when it's possible to write