|
Java EE 5 SDK | ||||||||
| 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(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 |
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. |
protected abstract ResponseWriter |
getWrapped()
|
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 |
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. |
| 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 |
|---|
protected abstract ResponseWriter getWrapped()
public String getContentType()
The default behavior of this method is to
call ResponseWriter.getContentType()
on the wrapped ResponseWriter object.
getContentType in class ResponseWriterResponseWriter.getContentType()public 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 IOException
The default behavior of this method is to
call ResponseWriter.flush()
on the wrapped ResponseWriter object.
flush in interface Flushableflush in class ResponseWriterIOExceptionResponseWriter.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 ResponseWriterIOException - 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 ResponseWriterIOException - 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 ResponseWritername - Name of the element to be startedcomponent - The UIComponent (if any) to which
this element corresponds
IOException - if an input/output error occursResponseWriter.startElement(String, javax.faces.component.UIComponent)
public 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 ResponseWritername - Name of the element to be ended
IOException - if an input/output error occursResponseWriter.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 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
IOException - 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 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
IOException - 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 ResponseWritercomment - Text content of the comment
IOException - if an input/output error occursResponseWriter.writeComment(Object)
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 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
IOException - 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 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
IOException - 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 ResponseWritertext - Text to be writtenoff - Starting offset (zero-relative)len - Number of characters to be written
IOException - 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 ResponseWriterwriter - The Writer that is the output destinationResponseWriter.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 Closeableclose in class WriterIOExceptionWriter.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 WriterIOExceptionWriter.write(char[], int, int)
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.