|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.io.Writer
javax.faces.context.ResponseWriter
javax.faces.context.ResponseWriterWrapper
public abstract class ResponseWriterWrapper
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.
| Field Summary |
|---|
| Fields inherited from class java.io.Writer |
|---|
lock |
| Constructor Summary | |
|---|---|
ResponseWriterWrapper()
|
|
| Method Summary | |
|---|---|
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 ResponseWriter#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. |
abstract ResponseWriter |
getWrapped()
Return the instance that we are wrapping. |
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 ResponseWriter#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 |
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. |
| Methods inherited from class java.io.Writer |
|---|
append, append, append, write, write, write, write |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ResponseWriterWrapper()
| Method Detail |
|---|
public abstract ResponseWriter getWrapped()
Return the instance that we are wrapping. As of version 2, this method is public.
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
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 error
public 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 error
public 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 ended
java.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 corresponds
java.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 corresponds
java.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 comment
java.io.IOException - if an input/output error occursResponseWriter#writeComment(Object)
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 corresponds
java.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 corresponds
java.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 written
java.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 destinationResponseWriter#cloneWithWriter(java.io.Writer)
public void close()
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter#close()
on the wrapped ResponseWriter object.
close in interface java.io.Closeableclose in class java.io.Writerjava.io.IOExceptionResponseWriter#close()
public void write(char[] cbuf,
int off,
int len)
throws java.io.IOException
The default behavior of this method is to
call ResponseWriter#write(char[], int, int)
on the wrapped ResponseWriter object.
write in class java.io.Writerjava.io.IOExceptionResponseWriter#write(char[], int, int)
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24