public abstract class ResponseWriterWrapper extends ResponseWriter implements FacesWrapper<ResponseWriter>
Provides a simple implementation
of ResponseWriter that
can be subclassed by developers wishing to provide specialized
behavior to an existing ResponseWriter instance. The default
implementation of all methods is to call through to the wrapped
ResponseWriter.
Usage: extend this class and push the implementation being wrapped to the
constructor and use getWrapped() to access the instance being wrapped.
| Constructor and Description |
|---|
ResponseWriterWrapper()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
ResponseWriterWrapper(ResponseWriter wrapped)
If this response writer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
| Modifier and Type | Method and Description |
|---|---|
ResponseWriter |
cloneWithWriter(java.io.Writer writer)
The default behavior of this method is to
call
ResponseWriter.cloneWithWriter(java.io.Writer)
on the wrapped ResponseWriter object. |
void |
close()
The default behavior of this method is to
call
Writer.close()
on the wrapped ResponseWriter object. |
void |
endCDATA()
The default behavior of this method
is to call |
void |
endDocument()
The default behavior of this method is to
call
ResponseWriter.endDocument()
on the wrapped ResponseWriter object. |
void |
endElement(java.lang.String name)
The default behavior of this method is to
call
ResponseWriter.endElement(String)
on the wrapped ResponseWriter object. |
void |
flush()
The default behavior of this method is to
call
ResponseWriter.flush()
on the wrapped ResponseWriter object. |
java.lang.String |
getCharacterEncoding()
The default behavior of this method is to
call
ResponseWriter.getCharacterEncoding()
on the wrapped ResponseWriter object. |
java.lang.String |
getContentType()
The default behavior of this method is to
call
ResponseWriter.getContentType()
on the wrapped ResponseWriter object. |
ResponseWriter |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
void |
startCDATA()
The default behavior of this method
is to call |
void |
startDocument()
The default behavior of this method is to
call
ResponseWriter.startDocument()
on the wrapped ResponseWriter object. |
void |
startElement(java.lang.String name,
UIComponent component)
The default behavior of this method is to
call
ResponseWriter.startElement(String, javax.faces.component.UIComponent)
on the wrapped ResponseWriter object. |
void |
write(char[] cbuf,
int off,
int len)
The default behavior of this method is to
call
Writer.write(char[], int, int)
on the wrapped ResponseWriter object. |
void |
writeAttribute(java.lang.String name,
java.lang.Object value,
java.lang.String property)
The default behavior of this method is to
call
ResponseWriter.writeAttribute(String, Object, String)
on the wrapped ResponseWriter object. |
void |
writeComment(java.lang.Object comment)
The default behavior of this method is to
call
ResponseWriter.writeComment(Object)
on the wrapped ResponseWriter object. |
void |
writeDoctype(java.lang.String doctype)
The default behavior of this method is to
call
ResponseWriter.writeDoctype(java.lang.String)
on the wrapped ResponseWriter object. |
void |
writePreamble(java.lang.String preamble)
The default behavior of this method is to
call
ResponseWriter.writePreamble(java.lang.String)
on the wrapped ResponseWriter object. |
void |
writeText(char[] text,
int off,
int len)
The default behavior of this method is to
call
ResponseWriter.writeText(char[], int, int)
on the wrapped ResponseWriter object. |
void |
writeText(java.lang.Object text,
java.lang.String property)
The default behavior of this method is to
call
ResponseWriter.writeText(Object, String)
on the wrapped ResponseWriter object. |
void |
writeText(java.lang.Object text,
UIComponent component,
java.lang.String property)
The default behavior of this method is to
call
ResponseWriter.writeText(Object, UIComponent, String)
on the wrapped ResponseWriter object. |
void |
writeURIAttribute(java.lang.String name,
java.lang.Object value,
java.lang.String property)
The default behavior of this method is to
call
ResponseWriter.writeURIAttribute(String, Object, String)
on the wrapped ResponseWriter object. |
@Deprecated public ResponseWriterWrapper()
public ResponseWriterWrapper(ResponseWriter wrapped)
If this response writer has been decorated,
the implementation doing the decorating should push the implementation being wrapped to this constructor.
The getWrapped() will then return the implementation being wrapped.
wrapped - The implementation being wrapped.public ResponseWriter getWrapped()
FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped in interface FacesWrapper<ResponseWriter>public java.lang.String getContentType()
The default behavior of this method is to
call ResponseWriter.getContentType()
on the wrapped ResponseWriter object.
getContentType in class ResponseWriterResponseWriter.getContentType()public java.lang.String getCharacterEncoding()
The default behavior of this method is to
call ResponseWriter.getCharacterEncoding()
on the wrapped ResponseWriter object.
getCharacterEncoding in class ResponseWriterResponseWriter.getCharacterEncoding()public void flush()
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.flush()
on the wrapped ResponseWriter object.
flush in interface java.io.Flushableflush in class ResponseWriterjava.io.IOExceptionResponseWriter.flush()public void startDocument()
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.startDocument()
on the wrapped ResponseWriter object.
startDocument in class ResponseWriterjava.io.IOException - if an input/output error occursResponseWriter.startDocument()public void endDocument()
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.endDocument()
on the wrapped ResponseWriter object.
endDocument in class ResponseWriterjava.io.IOException - if an input/output error occursResponseWriter.endDocument()public void startElement(java.lang.String name,
UIComponent component)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.startElement(String, javax.faces.component.UIComponent)
on the wrapped ResponseWriter object.
startElement in class ResponseWritername - Name of the element to be startedcomponent - The UIComponent (if any) to which this
element corresponds. This component is
inspected for its pass through attributes as
described in the standard HTML_BASIC RenderKit specification.java.io.IOException - if an input/output error occursResponseWriter.startElement(String, javax.faces.component.UIComponent)public void startCDATA()
throws java.io.IOException
The default behavior of this method
is to call ResponseWriter.startCDATA() on the wrapped
ResponseWriter object.
startCDATA in class ResponseWriterjava.io.IOException - on any read/write errorpublic void endCDATA()
throws java.io.IOException
The default behavior of this method
is to call ResponseWriter.endCDATA() on the wrapped
ResponseWriter object.
endCDATA in class ResponseWriterjava.io.IOException - on any read/write errorpublic void endElement(java.lang.String name)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.endElement(String)
on the wrapped ResponseWriter object.
endElement in class ResponseWritername - Name of the element to be endedjava.io.IOException - on any read/write errorResponseWriter.endElement(String)public void writeAttribute(java.lang.String name,
java.lang.Object value,
java.lang.String property)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writeAttribute(String, Object, String)
on the wrapped ResponseWriter object.
writeAttribute in class ResponseWritername - Attribute name to be addedvalue - Attribute value to be addedproperty - Name of the property or attribute (if any) of the
UIComponent associated with the containing element,
to which this generated attribute correspondsjava.io.IOException - if an input/output error occursResponseWriter.writeAttribute(String, Object, String)public void writeURIAttribute(java.lang.String name,
java.lang.Object value,
java.lang.String property)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writeURIAttribute(String, Object, String)
on the wrapped ResponseWriter object.
writeURIAttribute in class ResponseWritername - Attribute name to be addedvalue - Attribute value to be addedproperty - Name of the property or attribute (if any) of the
UIComponent associated with the containing element,
to which this generated attribute correspondsjava.io.IOException - if an input/output error occursResponseWriter.writeURIAttribute(String, Object, String)public void writeComment(java.lang.Object comment)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writeComment(Object)
on the wrapped ResponseWriter object.
writeComment in class ResponseWritercomment - Text content of the commentjava.io.IOException - if an input/output error occursResponseWriter.writeComment(Object)public void writeDoctype(java.lang.String doctype)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writeDoctype(java.lang.String)
on the wrapped ResponseWriter object.
writeDoctype in class ResponseWriterdoctype - Text content of the doctypejava.io.IOException - if an input/output error occursResponseWriter.writeDoctype(java.lang.String)public void writePreamble(java.lang.String preamble)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writePreamble(java.lang.String)
on the wrapped ResponseWriter object.
writePreamble in class ResponseWriterpreamble - Text content of the preamblejava.io.IOException - if an input/output error occursResponseWriter.writePreamble(java.lang.String)public void writeText(java.lang.Object text,
java.lang.String property)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writeText(Object, String)
on the wrapped ResponseWriter object.
writeText in class ResponseWritertext - Text to be writtenproperty - Name of the property or attribute (if any) of the
UIComponent associated with the containing element,
to which this generated text correspondsjava.io.IOException - if an input/output error occursResponseWriter.writeText(Object, String)public void writeText(java.lang.Object text,
UIComponent component,
java.lang.String property)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writeText(Object, UIComponent, String)
on the wrapped ResponseWriter object.
writeText in class ResponseWritertext - Text to be writtencomponent - The UIComponent (if any) to which
this element correspondsproperty - Name of the property or attribute (if any) of the
UIComponent associated with the containing element,
to which this generated text correspondsjava.io.IOException - if an input/output error occursResponseWriter.writeText(Object, String)public void writeText(char[] text,
int off,
int len)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter.writeText(char[], int, int)
on the wrapped ResponseWriter object.
writeText in class ResponseWritertext - Text to be writtenoff - Starting offset (zero-relative)len - Number of characters to be writtenjava.io.IOException - if an input/output error occursResponseWriter.writeText(char[], int, int)public ResponseWriter cloneWithWriter(java.io.Writer writer)
The default behavior of this method is to
call ResponseWriter.cloneWithWriter(java.io.Writer)
on the wrapped ResponseWriter object.
cloneWithWriter in class ResponseWriterwriter - The Writer that is the output destinationResponseWriterResponseWriter.cloneWithWriter(java.io.Writer)public void close()
throws java.io.IOException
The default behavior of this method is to
call Writer.close()
on the wrapped ResponseWriter object.
close in interface java.io.Closeableclose in interface java.lang.AutoCloseableclose in class java.io.Writerjava.io.IOExceptionWriter.close()public void write(char[] cbuf,
int off,
int len)
throws java.io.IOException
The default behavior of this method is to
call Writer.write(char[], int, int)
on the wrapped ResponseWriter object.
write in class java.io.Writerjava.io.IOExceptionWriter.write(char[], int, int)