ResponseWriterWrapper (Java EE 5)

java.lang.Object
  java.io.Writer
      javax.faces.context.ResponseWriter
          javax.faces.context.ResponseWriterWrapper

提供 ResponseWriter 的简单实现，可供希望向现有 ResponseWriter 实例提供特殊行为的开发人员进行子类化。所有方法的默认实现均接通包装的 ResponseWriter。

用法：扩展此类并重写 #getWrapped，以返回包装的实例。

since

1.2

英文文档：

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

 

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()

英文文档：

ResponseWriterWrapper

public ResponseWriterWrapper()

Method Detail

abstract protected ResponseWriter getWrapped()

return

正在包装的实例。

英文文档：

getWrapped

protected abstract ResponseWriter getWrapped()

Returns:

the instance that we are wrapping.

---

public String getContentType()

此方法的默认行为是对包装的 ResponseWriter 对象调用 getContentType()。

since	1.2
See also	getContentType()

英文文档：

getContentType

public String getContentType()

The default behavior of this method is to call ResponseWriter.getContentType() on the wrapped ResponseWriter object.

Specified by:

getContentType in class ResponseWriter

Since:

1.2

See Also:

ResponseWriter.getContentType()

---

public String getCharacterEncoding()

此方法的默认行为是对包装的 ResponseWriter 对象调用 getCharacterEncoding()。

since	1.2
See also	getCharacterEncoding()

英文文档：

getCharacterEncoding

public String getCharacterEncoding()

The default behavior of this method is to call ResponseWriter.getCharacterEncoding() on the wrapped ResponseWriter object.

Specified by:

getCharacterEncoding in class ResponseWriter

Since:

1.2

See Also:

ResponseWriter.getCharacterEncoding()

---

public void flush() throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 flush()。

since	1.2
See also	flush()

英文文档：

flush

public void flush()
           throws IOException

The default behavior of this method is to call ResponseWriter.flush() on the wrapped ResponseWriter object.

Specified by:

flush in interface Flushable

Specified by:

flush in class ResponseWriter

Throws:

IOException

Since:

1.2

See Also:

ResponseWriter.flush()

---

public void startDocument() throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 startDocument()。

since	1.2
See also	startDocument()

英文文档：

startDocument

public void startDocument()
                   throws IOException

The default behavior of this method is to call ResponseWriter.startDocument() on the wrapped ResponseWriter object.

Specified by:

startDocument in class ResponseWriter

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.startDocument()

---

public void endDocument() throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 endDocument()。

since	1.2
See also	endDocument()

英文文档：

endDocument

public void endDocument()
                 throws IOException

The default behavior of this method is to call ResponseWriter.endDocument() on the wrapped ResponseWriter object.

Specified by:

endDocument in class ResponseWriter

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.endDocument()

---

public void startElement(String name, UIComponent component) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 startElement(String, javax.faces.component.UIComponent)。

since	1.2
See also	startElement(String, javax.faces.component.UIComponent)

英文文档：

startElement

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.

Specified by:

startElement in class ResponseWriter

Parameters:

name - Name of the element to be started

component - The UIComponent (if any) to which this element corresponds

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.startElement(String, javax.faces.component.UIComponent)

---

public void endElement(String name) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 endElement(String)。

since	1.2
See also	endElement(String)

英文文档：

endElement

public void endElement(String name)
                throws IOException

The default behavior of this method is to call ResponseWriter.endElement(String) on the wrapped ResponseWriter object.

Specified by:

endElement in class ResponseWriter

Parameters:

name - Name of the element to be ended

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.endElement(String)

---

public void writeAttribute(String name, Object value, String property) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 writeAttribute(String, Object, String)。

since	1.2
See also	writeAttribute(String, Object, String)

英文文档：

writeAttribute

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.

Specified by:

writeAttribute in class ResponseWriter

Parameters:

name - Attribute name to be added

value - Attribute value to be added

property - Name of the property or attribute (if any) of the UIComponent associated with the containing element, to which this generated attribute corresponds

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.writeAttribute(String, Object, String)

---

public void writeURIAttribute(String name, Object value, String property) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 writeURIAttribute(String, Object, String)。

since	1.2
See also	writeURIAttribute(String, Object, String)

英文文档：

writeURIAttribute

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.

Specified by:

writeURIAttribute in class ResponseWriter

Parameters:

name - Attribute name to be added

value - Attribute value to be added

property - Name of the property or attribute (if any) of the UIComponent associated with the containing element, to which this generated attribute corresponds

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.writeURIAttribute(String, Object, String)

---

public void writeComment(Object comment) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 writeComment(Object)。

since	1.2
See also	writeComment(Object)

英文文档：

writeComment

public void writeComment(Object comment)
                  throws IOException

The default behavior of this method is to call ResponseWriter.writeComment(Object) on the wrapped ResponseWriter object.

Specified by:

writeComment in class ResponseWriter

Parameters:

comment - Text content of the comment

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.writeComment(Object)

---

public void writeText(Object text, String property) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 writeText(Object, String)。

since	1.2
See also	writeText(Object, String)

英文文档：

writeText

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.

Specified by:

writeText in class ResponseWriter

Parameters:

text - Text to be written

property - Name of the property or attribute (if any) of the UIComponent associated with the containing element, to which this generated text corresponds

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.writeText(Object, String)

---

public void writeText(Object text, UIComponent component, String property) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 writeText(Object, UIComponent, String)。

since	1.2
See also	writeText(Object, String)

英文文档：

writeText

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.

Overrides:

writeText in class ResponseWriter

Parameters:

text - Text to be written

component - The UIComponent (if any) to which this element corresponds

property - Name of the property or attribute (if any) of the UIComponent associated with the containing element, to which this generated text corresponds

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.writeText(Object, String)

---

public void writeText(char[] text, int off, int len) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 writeText(char[], int, int)。

since	1.2
See also	writeText(char[], int, int)

英文文档：

writeText

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.

Specified by:

writeText in class ResponseWriter

Parameters:

text - Text to be written

off - Starting offset (zero-relative)

len - Number of characters to be written

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

ResponseWriter.writeText(char[], int, int)

---

public ResponseWriter cloneWithWriter(java.io.Writer writer)

此方法的默认行为是对包装的 ResponseWriter 对象调用 cloneWithWriter(java.io.Writer)。

since	1.2
See also	cloneWithWriter(java.io.Writer)

英文文档：

cloneWithWriter

public ResponseWriter cloneWithWriter(Writer writer)

The default behavior of this method is to call ResponseWriter.cloneWithWriter(java.io.Writer) on the wrapped ResponseWriter object.

Specified by:

cloneWithWriter in class ResponseWriter

Parameters:

writer - The Writer that is the output destination

Since:

1.2

See Also:

ResponseWriter.cloneWithWriter(java.io.Writer)

---

public void close() throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 close()。

since	1.2
See also	close()

英文文档：

close

public void close()
           throws IOException

The default behavior of this method is to call Writer.close() on the wrapped ResponseWriter object.

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

Since:

1.2

See Also:

Writer.close()

---

public void write(char[] cbuf, int off, int len) throws java.io.IOException

此方法的默认行为是对包装的 ResponseWriter 对象调用 write(char[], int, int)。

since	1.2
See also	write(char[], int, int)

英文文档：

write

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.

Specified by:

write in class Writer

Throws:

IOException

Since:

1.2

See Also:

Writer.write(char[], int, int)

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.