Jakarta EE 11.0.0 · jakarta.servlet.ServletResponseWrapper

Modifier and Type	Field and Description
private ServletResponse	response

Access	Constructor and Description
public	ServletResponseWrapper(ServletResponse the `ServletResponse` to be wrapped response) Creates a ServletResponse adaptor wrapping the given response object.

Method Summary

Modifier and Type	Method and Description
public void	flushBuffer() Implements jakarta.servlet.ServletResponse.flushBuffer. The default behavior of this method is to call flushBuffer() on the wrapped response object.
public int	getBufferSize() Implements jakarta.servlet.ServletResponse.getBufferSize. The default behavior of this method is to return getBufferSize() on the wrapped response object.
public String	getCharacterEncoding() Implements jakarta.servlet.ServletResponse.getCharacterEncoding. The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
public String	getContentType() Implements jakarta.servlet.ServletResponse.getContentType. The default behavior of this method is to return getContentType() on the wrapped response object.
public Locale	getLocale() Implements jakarta.servlet.ServletResponse.getLocale. The default behavior of this method is to return getLocale() on the wrapped response object.
public ServletOutputStream	getOutputStream() Implements jakarta.servlet.ServletResponse.getOutputStream. The default behavior of this method is to return getOutputStream() on the wrapped response object.
public ServletResponse	Returns: the wrapped `ServletResponse` getResponse() Return the wrapped ServletResponse object.
public PrintWriter	getWriter() Implements jakarta.servlet.ServletResponse.getWriter. The default behavior of this method is to return getWriter() on the wrapped response object.
public boolean	isCommitted() Implements jakarta.servlet.ServletResponse.isCommitted. The default behavior of this method is to return isCommitted() on the wrapped response object.
public boolean	Returns: true if this ServletResponseWrapper wraps the given ServletResponse instance, false otherwise isWrapperFor(ServletResponse the ServletResponse instance to search for wrapped) Checks (recursively) if this ServletResponseWrapper wraps the given `ServletResponse` instance.
public boolean	Returns: true if this ServletResponseWrapper wraps a ServletResponse of the given class type, false otherwise isWrapperFor(Class<?> the ServletResponse class type to search for wrappedType) Checks (recursively) if this ServletResponseWrapper wraps a `ServletResponse` of the given class type.
public void	reset() Implements jakarta.servlet.ServletResponse.reset. The default behavior of this method is to call reset() on the wrapped response object.
public void	resetBuffer() Implements jakarta.servlet.ServletResponse.resetBuffer. The default behavior of this method is to call resetBuffer() on the wrapped response object.
public void	setBufferSize(int the preferred buffer size size) Implements jakarta.servlet.ServletResponse.setBufferSize. The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
public void	setCharacterEncoding(String a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets) or `null` encoding) Implements jakarta.servlet.ServletResponse.setCharacterEncoding. The default behavior of this method is to call setCharacterEncoding(String encoding) on the wrapped response object.
public void	setCharacterEncoding(Charset a Charset instance representing the encoding to use or `null` encoding) Overrides default jakarta.servlet.ServletResponse.setCharacterEncoding. The default behavior of this method is to call setCharacterEncoding(Charset encoding) on the wrapped response object.
public void	setContentLength(int an integer specifying the length of the content being returned to the client; sets the Content-Length header len) Implements jakarta.servlet.ServletResponse.setContentLength. The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
public void	setContentLengthLong(long a long specifying the length of the content being returned to the client; sets the Content-Length header len) Implements jakarta.servlet.ServletResponse.setContentLengthLong. The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.
public void	setContentType(String a `String` specifying the MIME type of the content or `null` type) Implements jakarta.servlet.ServletResponse.setContentType. The default behavior of this method is to call setContentType(String type) on the wrapped response object.
public void	setLocale(Locale the locale of the response or {code @null} loc) Implements jakarta.servlet.ServletResponse.setLocale. The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
public void	setResponse(ServletResponse the `ServletResponse` to be installed response) Sets the response being wrapped.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

response	back to summary
private ServletResponse response

ServletResponseWrapper	back to summary
public ServletResponseWrapper(ServletResponse response) Creates a ServletResponse adaptor wrapping the given response object. Parameters response:ServletResponse the `ServletResponse` to be wrapped Exceptions IllegalArgumentException: if the response is null.

Method Detail

flushBuffer	back to summary
public void flushBuffer() throws IOException Implements jakarta.servlet.ServletResponse.flushBuffer. The default behavior of this method is to call flushBuffer() on the wrapped response object. Annotations @Override Exceptions IOException: Doc from jakarta.servlet.ServletResponse.flushBuffer. if the act of flushing the buffer cannot be completed.

flushBuffer

back to summary

public void flushBuffer() throws IOException

Implements jakarta.servlet.ServletResponse.flushBuffer.

The default behavior of this method is to call flushBuffer() on the wrapped response object.

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.ServletResponse.flushBuffer.

if the act of flushing the buffer cannot be completed.

getBufferSize	back to summary
public int getBufferSize() Implements jakarta.servlet.ServletResponse.getBufferSize. The default behavior of this method is to return getBufferSize() on the wrapped response object. Returns:int Doc from jakarta.servlet.ServletResponse.getBufferSize. the actual buffer size used Annotations @Override

getBufferSize

back to summary

public int getBufferSize()

Implements jakarta.servlet.ServletResponse.getBufferSize.

The default behavior of this method is to return getBufferSize() on the wrapped response object.

Returns:int

Doc from jakarta.servlet.ServletResponse.getBufferSize.

the actual buffer size used

Annotations

@Override

getCharacterEncoding back to summary

getCharacterEncoding	back to summary
public String getCharacterEncoding() Implements jakarta.servlet.ServletResponse.getCharacterEncoding. The default behavior of this method is to return getCharacterEncoding() on the wrapped response object. Returns:String Doc from jakarta.servlet.ServletResponse.getCharacterEncoding. a `String` specifying the name of the character encoding, for example, `UTF-8` Annotations @Override

public String getCharacterEncoding()

Implements jakarta.servlet.ServletResponse.getCharacterEncoding.

The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.

Returns:String

Doc from jakarta.servlet.ServletResponse.getCharacterEncoding.

a String specifying the name of the character encoding, for example, UTF-8

Annotations

@Override

getContentType back to summary

getContentType	back to summary
public String getContentType() Implements jakarta.servlet.ServletResponse.getContentType. The default behavior of this method is to return getContentType() on the wrapped response object. Returns:String Doc from jakarta.servlet.ServletResponse.getContentType. a `String` specifying the content type, for example, `text/html; charset=UTF-8`, or null Annotations @Override Since Servlet 2.4

public String getContentType()

Implements jakarta.servlet.ServletResponse.getContentType.

The default behavior of this method is to return getContentType() on the wrapped response object.

Returns:String

Doc from jakarta.servlet.ServletResponse.getContentType.

a String specifying the content type, for example, text/html; charset=UTF-8, or null

Annotations

@Override

Since

Servlet 2.4

getLocale	back to summary
public Locale getLocale() Implements jakarta.servlet.ServletResponse.getLocale. The default behavior of this method is to return getLocale() on the wrapped response object. Returns:Locale Doc from jakarta.servlet.ServletResponse.getLocale. the Locale for this response. Annotations @Override

getLocale

back to summary

public Locale getLocale()

Implements jakarta.servlet.ServletResponse.getLocale.

The default behavior of this method is to return getLocale() on the wrapped response object.

Returns:Locale

Doc from jakarta.servlet.ServletResponse.getLocale.

the Locale for this response.

Annotations

@Override

getOutputStream back to summary

getOutputStream	back to summary
public ServletOutputStream getOutputStream() throws IOException Implements jakarta.servlet.ServletResponse.getOutputStream. The default behavior of this method is to return getOutputStream() on the wrapped response object. Returns:ServletOutputStream Doc from jakarta.servlet.ServletResponse.getOutputStream. a `ServletOutputStream` for writing binary data Annotations @Override Exceptions IOException: Doc from jakarta.servlet.ServletResponse.getOutputStream. if an input or output exception occurred

public ServletOutputStream getOutputStream() throws IOException

Implements jakarta.servlet.ServletResponse.getOutputStream.

The default behavior of this method is to return getOutputStream() on the wrapped response object.

Returns:ServletOutputStream

Doc from jakarta.servlet.ServletResponse.getOutputStream.

a ServletOutputStream for writing binary data

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.ServletResponse.getOutputStream.

if an input or output exception occurred

getResponse back to summary

getResponse	back to summary
public ServletResponse getResponse() Return the wrapped ServletResponse object. Returns:ServletResponse the wrapped `ServletResponse`

public ServletResponse getResponse()

Return the wrapped ServletResponse object.

Returns:ServletResponse: the wrapped ServletResponse

getWriter back to summary

getWriter	back to summary
public PrintWriter getWriter() throws IOException Implements jakarta.servlet.ServletResponse.getWriter. The default behavior of this method is to return getWriter() on the wrapped response object. Returns:PrintWriter Doc from jakarta.servlet.ServletResponse.getWriter. a `PrintWriter` object that can return character data to the client Annotations @Override Exceptions IOException: Doc from jakarta.servlet.ServletResponse.getWriter. if an input or output exception occurred

public PrintWriter getWriter() throws IOException

Implements jakarta.servlet.ServletResponse.getWriter.

The default behavior of this method is to return getWriter() on the wrapped response object.

Returns:PrintWriter

Doc from jakarta.servlet.ServletResponse.getWriter.

a PrintWriter object that can return character data to the client

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.servlet.ServletResponse.getWriter.

if an input or output exception occurred

isCommitted	back to summary
public boolean isCommitted() Implements jakarta.servlet.ServletResponse.isCommitted. The default behavior of this method is to return isCommitted() on the wrapped response object. Returns:boolean Doc from jakarta.servlet.ServletResponse.isCommitted. a boolean indicating if the response has been committed Annotations @Override

isCommitted

back to summary

public boolean isCommitted()

Implements jakarta.servlet.ServletResponse.isCommitted.

The default behavior of this method is to return isCommitted() on the wrapped response object.

Returns:boolean

Doc from jakarta.servlet.ServletResponse.isCommitted.

a boolean indicating if the response has been committed

Annotations

@Override

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(ServletResponse wrapped) Checks (recursively) if this ServletResponseWrapper wraps the given `ServletResponse` instance. Parameters wrapped:ServletResponse the ServletResponse instance to search for Returns:boolean true if this ServletResponseWrapper wraps the given ServletResponse instance, false otherwise Since Servlet 3.0

public boolean isWrapperFor(ServletResponse wrapped)

Checks (recursively) if this ServletResponseWrapper wraps the given ServletResponse instance.

Parameters

wrapped:ServletResponse: the ServletResponse instance to search for

Returns:boolean

true if this ServletResponseWrapper wraps the given ServletResponse instance, false otherwise

Since

Servlet 3.0

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(Class<?> wrappedType) Checks (recursively) if this ServletResponseWrapper wraps a `ServletResponse` of the given class type. Parameters wrappedType:Class<?> the ServletResponse class type to search for Returns:boolean true if this ServletResponseWrapper wraps a ServletResponse of the given class type, false otherwise Exceptions IllegalArgumentException: if the given class does not implement `ServletResponse` Since Servlet 3.0

public boolean isWrapperFor(Class<?> wrappedType)

Checks (recursively) if this ServletResponseWrapper wraps a ServletResponse of the given class type.

Parameters

wrappedType:Class<?>: the ServletResponse class type to search for

Returns:boolean

true if this ServletResponseWrapper wraps a ServletResponse of the given class type, false otherwise

Exceptions

IllegalArgumentException:: if the given class does not implement ServletResponse

Since

Servlet 3.0

reset	back to summary
public void reset() Implements jakarta.servlet.ServletResponse.reset. The default behavior of this method is to call reset() on the wrapped response object. Annotations @Override

reset

back to summary

public void reset()

Implements jakarta.servlet.ServletResponse.reset.

The default behavior of this method is to call reset() on the wrapped response object.

Annotations

@Override

resetBuffer	back to summary
public void resetBuffer() Implements jakarta.servlet.ServletResponse.resetBuffer. The default behavior of this method is to call resetBuffer() on the wrapped response object. Annotations @Override

resetBuffer

back to summary

public void resetBuffer()

Implements jakarta.servlet.ServletResponse.resetBuffer.

The default behavior of this method is to call resetBuffer() on the wrapped response object.

Annotations

@Override

setBufferSize	back to summary
public void setBufferSize(int size) Implements jakarta.servlet.ServletResponse.setBufferSize. The default behavior of this method is to call setBufferSize(int size) on the wrapped response object. Parameters size:int Doc from jakarta.servlet.ServletResponse.setBufferSize. the preferred buffer size Annotations @Override

setBufferSize

back to summary

public void setBufferSize(int size)

Implements jakarta.servlet.ServletResponse.setBufferSize.

The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.

Parameters

size:int

Doc from jakarta.servlet.ServletResponse.setBufferSize.

the preferred buffer size

Annotations

@Override

setCharacterEncoding back to summary

setCharacterEncoding	back to summary
public void setCharacterEncoding(String encoding) Implements jakarta.servlet.ServletResponse.setCharacterEncoding. The default behavior of this method is to call setCharacterEncoding(String encoding) on the wrapped response object. Parameters encoding:String Doc from jakarta.servlet.ServletResponse.setCharacterEncoding. a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets) or `null` Annotations @Override Since Servlet 2.4

public void setCharacterEncoding(String encoding)

Implements jakarta.servlet.ServletResponse.setCharacterEncoding.

The default behavior of this method is to call setCharacterEncoding(String encoding) on the wrapped response object.

Parameters

encoding:String

Doc from jakarta.servlet.ServletResponse.setCharacterEncoding.

a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets) or null

Annotations

@Override

Since

Servlet 2.4

setCharacterEncoding back to summary

setCharacterEncoding	back to summary
public void setCharacterEncoding(Charset encoding) Overrides default jakarta.servlet.ServletResponse.setCharacterEncoding. The default behavior of this method is to call setCharacterEncoding(Charset encoding) on the wrapped response object. Parameters encoding:Charset Doc from jakarta.servlet.ServletResponse.setCharacterEncoding. a Charset instance representing the encoding to use or `null` Annotations @Override Since Servlet 6.1

public void setCharacterEncoding(Charset encoding)

Overrides default jakarta.servlet.ServletResponse.setCharacterEncoding.

The default behavior of this method is to call setCharacterEncoding(Charset encoding) on the wrapped response object.

Parameters

encoding:Charset

Doc from jakarta.servlet.ServletResponse.setCharacterEncoding.

a Charset instance representing the encoding to use or null

Annotations

@Override

Since

Servlet 6.1

setContentLength	back to summary
public void setContentLength(int len) Implements jakarta.servlet.ServletResponse.setContentLength. The default behavior of this method is to call setContentLength(int len) on the wrapped response object. Parameters len:int Doc from jakarta.servlet.ServletResponse.setContentLength. an integer specifying the length of the content being returned to the client; sets the Content-Length header Annotations @Override

setContentLength

back to summary

public void setContentLength(int len)

Implements jakarta.servlet.ServletResponse.setContentLength.

The default behavior of this method is to call setContentLength(int len) on the wrapped response object.

Parameters

len:int

Doc from jakarta.servlet.ServletResponse.setContentLength.

an integer specifying the length of the content being returned to the client; sets the Content-Length header

Annotations

@Override

setContentLengthLong	back to summary
public void setContentLengthLong(long len) Implements jakarta.servlet.ServletResponse.setContentLengthLong. The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object. Parameters len:long Doc from jakarta.servlet.ServletResponse.setContentLengthLong. a long specifying the length of the content being returned to the client; sets the Content-Length header Annotations @Override Since Servlet 3.1

setContentLengthLong

back to summary

public void setContentLengthLong(long len)

Implements jakarta.servlet.ServletResponse.setContentLengthLong.

The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.

Parameters

len:long

Doc from jakarta.servlet.ServletResponse.setContentLengthLong.

a long specifying the length of the content being returned to the client; sets the Content-Length header

Annotations

@Override

Since

Servlet 3.1

setContentType back to summary

setContentType	back to summary
public void setContentType(String type) Implements jakarta.servlet.ServletResponse.setContentType. The default behavior of this method is to call setContentType(String type) on the wrapped response object. Parameters type:String Doc from jakarta.servlet.ServletResponse.setContentType. a `String` specifying the MIME type of the content or `null` Annotations @Override

public void setContentType(String type)

Implements jakarta.servlet.ServletResponse.setContentType.

The default behavior of this method is to call setContentType(String type) on the wrapped response object.

Parameters

type:String

Doc from jakarta.servlet.ServletResponse.setContentType.

a String specifying the MIME type of the content or null

Annotations

@Override

setLocale	back to summary
public void setLocale(Locale loc) Implements jakarta.servlet.ServletResponse.setLocale. The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object. Parameters loc:Locale Doc from jakarta.servlet.ServletResponse.setLocale. the locale of the response or {code @null} Annotations @Override

setLocale

back to summary

public void setLocale(Locale loc)

Implements jakarta.servlet.ServletResponse.setLocale.

The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.

Parameters

loc:Locale

Doc from jakarta.servlet.ServletResponse.setLocale.

the locale of the response or {code @null}

Annotations

@Override

setResponse back to summary

setResponse	back to summary
public void setResponse(ServletResponse response) Sets the response being wrapped. Parameters response:ServletResponse the `ServletResponse` to be installed Exceptions IllegalArgumentException: if the response is null.

public void setResponse(ServletResponse response)

Sets the response being wrapped.

Parameters

response:ServletResponse: the ServletResponse to be installed

Exceptions

IllegalArgumentException:: if the response is null.

public Class ServletResponseWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail