Class ResponseWriterWrapper
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
,FacesWrapper<ResponseWriter>
- Direct Known Subclasses:
PartialResponseWriter
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 override getWrapped()
to
return the instance we are wrapping.
- Since:
- 1.2
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncloneWithWriter
(Writer writer) The default behavior of this method is to callResponseWriter.cloneWithWriter(java.io.Writer)
on the wrappedResponseWriter
object.void
close()
The default behavior of this method is to callWriter.close()
on the wrappedResponseWriter
object.void
endCDATA()
The default behavior of this method is to callResponseWriter.endCDATA()
on the wrappedResponseWriter
object.void
The default behavior of this method is to callResponseWriter.endDocument()
on the wrappedResponseWriter
object.void
endElement
(String name) The default behavior of this method is to callResponseWriter.endElement(String)
on the wrappedResponseWriter
object.void
flush()
The default behavior of this method is to callResponseWriter.flush()
on the wrappedResponseWriter
object.The default behavior of this method is to callResponseWriter.getCharacterEncoding()
on the wrappedResponseWriter
object.The default behavior of this method is to callResponseWriter.getContentType()
on the wrappedResponseWriter
object.abstract ResponseWriter
Return the instance that we are wrapping.void
The default behavior of this method is to callResponseWriter.startCDATA()
on the wrappedResponseWriter
object.void
The default behavior of this method is to callResponseWriter.startDocument()
on the wrappedResponseWriter
object.void
startElement
(String name, UIComponent component) The default behavior of this method is to callResponseWriter.startElement(String, javax.faces.component.UIComponent)
on the wrappedResponseWriter
object.void
write
(char[] cbuf, int off, int len) The default behavior of this method is to callWriter.write(char[], int, int)
on the wrappedResponseWriter
object.void
writeAttribute
(String name, Object value, String property) The default behavior of this method is to callResponseWriter.writeAttribute(String, Object, String)
on the wrappedResponseWriter
object.void
writeComment
(Object comment) The default behavior of this method is to callResponseWriter.writeComment(Object)
on the wrappedResponseWriter
object.void
writeDoctype
(String doctype) The default behavior of this method is to callResponseWriter.writeDoctype(java.lang.String)
on the wrappedResponseWriter
object.void
writePreamble
(String preamble) The default behavior of this method is to callResponseWriter.writePreamble(java.lang.String)
on the wrappedResponseWriter
object.void
writeText
(char[] text, int off, int len) The default behavior of this method is to callResponseWriter.writeText(char[], int, int)
on the wrappedResponseWriter
object.void
The default behavior of this method is to callResponseWriter.writeText(Object, String)
on the wrappedResponseWriter
object.void
writeText
(Object text, UIComponent component, String property) The default behavior of this method is to callResponseWriter.writeText(Object, UIComponent, String)
on the wrappedResponseWriter
object.void
writeURIAttribute
(String name, Object value, String property) The default behavior of this method is to callResponseWriter.writeURIAttribute(String, Object, String)
on the wrappedResponseWriter
object.
-
Constructor Details
-
ResponseWriterWrapper
public ResponseWriterWrapper()
-
-
Method Details
-
getWrapped
Return the instance that we are wrapping. As of version 2, this method is public.
- Specified by:
getWrapped
in interfaceFacesWrapper<ResponseWriter>
-
getContentType
The default behavior of this method is to call
ResponseWriter.getContentType()
on the wrappedResponseWriter
object.- Specified by:
getContentType
in classResponseWriter
- Since:
- 1.2
- See Also:
-
getCharacterEncoding
The default behavior of this method is to call
ResponseWriter.getCharacterEncoding()
on the wrappedResponseWriter
object.- Specified by:
getCharacterEncoding
in classResponseWriter
- Since:
- 1.2
- See Also:
-
flush
The default behavior of this method is to call
ResponseWriter.flush()
on the wrappedResponseWriter
object.- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classResponseWriter
- Throws:
IOException
- Since:
- 1.2
- See Also:
-
startDocument
The default behavior of this method is to call
ResponseWriter.startDocument()
on the wrappedResponseWriter
object.- Specified by:
startDocument
in classResponseWriter
- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
endDocument
The default behavior of this method is to call
ResponseWriter.endDocument()
on the wrappedResponseWriter
object.- Specified by:
endDocument
in classResponseWriter
- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
startElement
The default behavior of this method is to call
ResponseWriter.startElement(String, javax.faces.component.UIComponent)
on the wrappedResponseWriter
object.- Specified by:
startElement
in classResponseWriter
- Parameters:
name
- Name of the element to be startedcomponent
- TheUIComponent
(if any) to which this element corresponds. This component is inspected for its pass through attributes as described in the standard HTML_BASICRenderKit
specification.- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
startCDATA
The default behavior of this method is to call
ResponseWriter.startCDATA()
on the wrappedResponseWriter
object.- Overrides:
startCDATA
in classResponseWriter
- Throws:
IOException
- on any read/write error- Since:
- 2.0
-
endCDATA
The default behavior of this method is to call
ResponseWriter.endCDATA()
on the wrappedResponseWriter
object.- Overrides:
endCDATA
in classResponseWriter
- Throws:
IOException
- on any read/write error- Since:
- 2.0
-
endElement
The default behavior of this method is to call
ResponseWriter.endElement(String)
on the wrappedResponseWriter
object.- Specified by:
endElement
in classResponseWriter
- Parameters:
name
- Name of the element to be ended- Throws:
IOException
- on any read/write error- Since:
- 1.2
- See Also:
-
writeAttribute
The default behavior of this method is to call
ResponseWriter.writeAttribute(String, Object, String)
on the wrappedResponseWriter
object.- Specified by:
writeAttribute
in classResponseWriter
- Parameters:
name
- Attribute name to be addedvalue
- Attribute value to be addedproperty
- Name of the property or attribute (if any) of theUIComponent
associated with the containing element, to which this generated attribute corresponds- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
writeURIAttribute
The default behavior of this method is to call
ResponseWriter.writeURIAttribute(String, Object, String)
on the wrappedResponseWriter
object.- Specified by:
writeURIAttribute
in classResponseWriter
- Parameters:
name
- Attribute name to be addedvalue
- Attribute value to be addedproperty
- Name of the property or attribute (if any) of theUIComponent
associated with the containing element, to which this generated attribute corresponds- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
writeComment
The default behavior of this method is to call
ResponseWriter.writeComment(Object)
on the wrappedResponseWriter
object.- Specified by:
writeComment
in classResponseWriter
- Parameters:
comment
- Text content of the comment- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
writeDoctype
The default behavior of this method is to call
ResponseWriter.writeDoctype(java.lang.String)
on the wrappedResponseWriter
object.- Overrides:
writeDoctype
in classResponseWriter
- Parameters:
doctype
- Text content of the doctype- Throws:
IOException
- if an input/output error occurs- Since:
- 2.2
- See Also:
-
writePreamble
The default behavior of this method is to call
ResponseWriter.writePreamble(java.lang.String)
on the wrappedResponseWriter
object.- Overrides:
writePreamble
in classResponseWriter
- Parameters:
preamble
- Text content of the preamble- Throws:
IOException
- if an input/output error occurs- Since:
- 2.2
- See Also:
-
writeText
The default behavior of this method is to call
ResponseWriter.writeText(Object, String)
on the wrappedResponseWriter
object.- Specified by:
writeText
in classResponseWriter
- Parameters:
text
- Text to be writtenproperty
- Name of the property or attribute (if any) of theUIComponent
associated with the containing element, to which this generated text corresponds- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
writeText
The default behavior of this method is to call
ResponseWriter.writeText(Object, UIComponent, String)
on the wrappedResponseWriter
object.- Overrides:
writeText
in classResponseWriter
- Parameters:
text
- Text to be writtencomponent
- TheUIComponent
(if any) to which this element correspondsproperty
- Name of the property or attribute (if any) of theUIComponent
associated with the containing element, to which this generated text corresponds- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
writeText
The default behavior of this method is to call
ResponseWriter.writeText(char[], int, int)
on the wrappedResponseWriter
object.- Specified by:
writeText
in classResponseWriter
- Parameters:
text
- Text to be writtenoff
- Starting offset (zero-relative)len
- Number of characters to be written- Throws:
IOException
- if an input/output error occurs- Since:
- 1.2
- See Also:
-
cloneWithWriter
The default behavior of this method is to call
ResponseWriter.cloneWithWriter(java.io.Writer)
on the wrappedResponseWriter
object.- Specified by:
cloneWithWriter
in classResponseWriter
- Parameters:
writer
- TheWriter
that is the output destination- Since:
- 1.2
- See Also:
-
close
The default behavior of this method is to call
Writer.close()
on the wrappedResponseWriter
object.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
- Since:
- 1.2
- See Also:
-
write
The default behavior of this method is to call
Writer.write(char[], int, int)
on the wrappedResponseWriter
object.- Specified by:
write
in classWriter
- Throws:
IOException
- Since:
- 1.2
- See Also:
-