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(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(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. |
String |
getCharacterEncoding()
The default behavior of this method is to
call
ResponseWriter.getCharacterEncoding()
on the wrapped ResponseWriter object. |
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(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(String name,
Object value,
String property)
The default behavior of this method is to
call
ResponseWriter.writeAttribute(String, Object, String)
on the wrapped ResponseWriter object. |
void |
writeComment(Object comment)
The default behavior of this method is to
call
ResponseWriter.writeComment(Object)
on the wrapped ResponseWriter object. |
void |
writeDoctype(String doctype)
The default behavior of this method is to
call
ResponseWriter.writeDoctype(java.lang.String)
on the wrapped ResponseWriter object. |
void |
writePreamble(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(Object text,
String property)
The default behavior of this method is to
call
ResponseWriter.writeText(Object, String)
on the wrapped ResponseWriter object. |
void |
writeText(Object text,
UIComponent component,
String property)
The default behavior of this method is to
call
ResponseWriter.writeText(Object, UIComponent, String)
on the wrapped ResponseWriter object. |
void |
writeURIAttribute(String name,
Object value,
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()
FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped
in interface FacesWrapper<ResponseWriter>
public String getContentType()
The default behavior of this method is to
call ResponseWriter.getContentType()
on the wrapped ResponseWriter
object.
getContentType
in class ResponseWriter
ResponseWriter.getContentType()
public String getCharacterEncoding()
The default behavior of this method is to
call ResponseWriter.getCharacterEncoding()
on the wrapped ResponseWriter
object.
getCharacterEncoding
in class ResponseWriter
ResponseWriter.getCharacterEncoding()
public void flush() throws IOException
The default behavior of this method is to
call ResponseWriter.flush()
on the wrapped ResponseWriter
object.
flush
in interface Flushable
flush
in class ResponseWriter
IOException
ResponseWriter.flush()
public void startDocument() throws IOException
The default behavior of this method is to
call ResponseWriter.startDocument()
on the wrapped ResponseWriter
object.
startDocument
in class ResponseWriter
IOException
- if an input/output error occursResponseWriter.startDocument()
public void endDocument() throws IOException
The default behavior of this method is to
call ResponseWriter.endDocument()
on the wrapped ResponseWriter
object.
endDocument
in class ResponseWriter
IOException
- if an input/output error occursResponseWriter.endDocument()
public void startElement(String name, UIComponent component) throws 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 ResponseWriter
name
- 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.IOException
- if an input/output error occursResponseWriter.startElement(String, javax.faces.component.UIComponent)
public void startCDATA() throws IOException
The default behavior of this method
is to call ResponseWriter.startCDATA()
on the wrapped
ResponseWriter
object.
startCDATA
in class ResponseWriter
IOException
- on any read/write errorpublic void endCDATA() throws IOException
The default behavior of this method
is to call ResponseWriter.endCDATA()
on the wrapped
ResponseWriter
object.
endCDATA
in class ResponseWriter
IOException
- on any read/write errorpublic void endElement(String name) throws IOException
The default behavior of this method is to
call ResponseWriter.endElement(String)
on the wrapped ResponseWriter
object.
endElement
in class ResponseWriter
name
- Name of the element to be endedIOException
- on any read/write errorResponseWriter.endElement(String)
public void writeAttribute(String name, Object value, String property) throws IOException
The default behavior of this method is to
call ResponseWriter.writeAttribute(String, Object, String)
on the wrapped ResponseWriter
object.
writeAttribute
in class ResponseWriter
name
- 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 correspondsIOException
- if an input/output error occursResponseWriter.writeAttribute(String, Object, String)
public void writeURIAttribute(String name, Object value, String property) throws IOException
The default behavior of this method is to
call ResponseWriter.writeURIAttribute(String, Object, String)
on the wrapped ResponseWriter
object.
writeURIAttribute
in class ResponseWriter
name
- 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 correspondsIOException
- if an input/output error occursResponseWriter.writeURIAttribute(String, Object, String)
public void writeComment(Object comment) throws IOException
The default behavior of this method is to
call ResponseWriter.writeComment(Object)
on the wrapped ResponseWriter
object.
writeComment
in class ResponseWriter
comment
- Text content of the commentIOException
- if an input/output error occursResponseWriter.writeComment(Object)
public void writeDoctype(String doctype) throws IOException
The default behavior of this method is to
call ResponseWriter.writeDoctype(java.lang.String)
on the wrapped ResponseWriter
object.
writeDoctype
in class ResponseWriter
doctype
- Text content of the doctypeIOException
- if an input/output error occursResponseWriter.writeDoctype(java.lang.String)
public void writePreamble(String preamble) throws IOException
The default behavior of this method is to
call ResponseWriter.writePreamble(java.lang.String)
on the wrapped ResponseWriter
object.
writePreamble
in class ResponseWriter
preamble
- Text content of the preambleIOException
- if an input/output error occursResponseWriter.writePreamble(java.lang.String)
public void writeText(Object text, String property) throws IOException
The default behavior of this method is to
call ResponseWriter.writeText(Object, String)
on the wrapped ResponseWriter
object.
writeText
in class ResponseWriter
text
- 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 correspondsIOException
- if an input/output error occursResponseWriter.writeText(Object, String)
public void writeText(Object text, UIComponent component, String property) throws IOException
The default behavior of this method is to
call ResponseWriter.writeText(Object, UIComponent, String)
on the wrapped ResponseWriter
object.
writeText
in class ResponseWriter
text
- 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 correspondsIOException
- if an input/output error occursResponseWriter.writeText(Object, String)
public void writeText(char[] text, int off, int len) throws IOException
The default behavior of this method is to
call ResponseWriter.writeText(char[], int, int)
on the wrapped ResponseWriter
object.
writeText
in class ResponseWriter
text
- Text to be writtenoff
- Starting offset (zero-relative)len
- Number of characters to be writtenIOException
- if an input/output error occursResponseWriter.writeText(char[], int, int)
public ResponseWriter cloneWithWriter(Writer writer)
The default behavior of this method is to
call ResponseWriter.cloneWithWriter(java.io.Writer)
on the wrapped ResponseWriter
object.
cloneWithWriter
in class ResponseWriter
writer
- The Writer
that is the output destinationResponseWriter
ResponseWriter.cloneWithWriter(java.io.Writer)
public void close() throws IOException
The default behavior of this method is to
call Writer.close()
on the wrapped ResponseWriter
object.
close
in interface Closeable
close
in interface AutoCloseable
close
in class Writer
IOException
Writer.close()
public void write(char[] cbuf, int off, int len) throws IOException
The default behavior of this method is to
call Writer.write(char[], int, int)
on the wrapped ResponseWriter
object.
write
in class Writer
IOException
Writer.write(char[], int, int)
Comments to: faces-dev@eclipse.org.
Copyright © 2019 Eclipse Foundation. All rights reserved.
Use is subject to license terms.