Package org.apache.myfaces.renderkit.html

Class HtmlResponseWriterImpl

java.lang.Object

java.io.Writer

jakarta.faces.context.ResponseWriter

org.apache.myfaces.renderkit.html.HtmlResponseWriterImpl

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

EarlyFlushHtmlResponseWriterImpl, HtmlBufferResponseWriterWrapper

public class HtmlResponseWriterImpl
extends ResponseWriter

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
HtmlResponseWriterImpl(Writer writer, String contentType, String characterEncoding)
HtmlResponseWriterImpl(Writer writer, String contentType, String characterEncoding, boolean wrapScriptContentWithXmlCommentTag)
HtmlResponseWriterImpl(Writer writer, String contentType, String characterEncoding, boolean wrapScriptContentWithXmlCommentTag, String writerContentTypeMode)

Method Summary

Modifier and Type	Method	Description
ResponseWriter	cloneWithWriter(Writer writer)
void	close()
void	endCDATA()
void	endDocument()
void	endElement(String name)
void	flush()
protected void	forceFlush()
String	getCharacterEncoding()
String	getContentType()
protected FacesContext	getFacesContext()
protected StreamCharBuffer	getInternalBuffer()
protected StreamCharBuffer	getInternalBuffer(boolean reset)
protected boolean	getWrapScriptContentWithXmlCommentTag()
String	getWriterContentTypeMode()
void	startCDATA()
void	startDocument()
void	startElement(String name, UIComponent uiComponent)
static boolean	supportsContentType(String contentType)
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)
void	writeAttribute(String name, Object value, String componentPropertyName)
void	writeComment(Object value)
void	writeText(char[] cbuf, int off, int len)
void	writeText(Object object, UIComponent component, String string)	This method ignores the UIComponent provided and simply calls writeText(Object,String)
void	writeText(Object value, String componentPropertyName)
void	writeURIAttribute(String name, Object value, String componentPropertyName)

Methods inherited from class jakarta.faces.context.ResponseWriter

writeDoctype, writePreamble

Methods inherited from class java.io.Writer

append, append, append, nullWriter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlResponseWriterImpl

public HtmlResponseWriterImpl(Writer writer,
                              String contentType,
                              String characterEncoding)

HtmlResponseWriterImpl

public HtmlResponseWriterImpl(Writer writer,
                              String contentType,
                              String characterEncoding,
                              boolean wrapScriptContentWithXmlCommentTag)

HtmlResponseWriterImpl

public HtmlResponseWriterImpl(Writer writer,
                              String contentType,
                              String characterEncoding,
                              boolean wrapScriptContentWithXmlCommentTag,
                              String writerContentTypeMode)
                       throws FacesException

Throws:

FacesException

Method Detail

supportsContentType

public static boolean supportsContentType(String contentType)

getContentType

public String getContentType()

Specified by:

getContentType in class ResponseWriter

getWriterContentTypeMode

public String getWriterContentTypeMode()

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in class ResponseWriter

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class ResponseWriter

Throws:

IOException

startDocument

public void startDocument()

Specified by:

startDocument in class ResponseWriter

endDocument

public void endDocument()
                 throws IOException

Specified by:

endDocument in class ResponseWriter

Throws:

IOException

startElement

public void startElement(String name,
                         UIComponent uiComponent)
                  throws IOException

Specified by:

startElement in class ResponseWriter

Throws:

IOException

startCDATA

public void startCDATA()
                throws IOException

Overrides:

startCDATA in class ResponseWriter

Throws:

IOException

endCDATA

public void endCDATA()
              throws IOException

Overrides:

endCDATA in class ResponseWriter

Throws:

IOException

endElement

public void endElement(String name)
                throws IOException

Specified by:

endElement in class ResponseWriter

Throws:

IOException

writeAttribute

public void writeAttribute(String name,
                           Object value,
                           String componentPropertyName)
                    throws IOException

Specified by:

writeAttribute in class ResponseWriter

Throws:

IOException

writeURIAttribute

public void writeURIAttribute(String name,
                              Object value,
                              String componentPropertyName)
                       throws IOException

Specified by:

writeURIAttribute in class ResponseWriter

Throws:

IOException

writeComment

public void writeComment(Object value)
                  throws IOException

Specified by:

writeComment in class ResponseWriter

Throws:

IOException

writeText

public void writeText(Object value,
                      String componentPropertyName)
               throws IOException

Specified by:

writeText in class ResponseWriter

Throws:

IOException

writeText

public void writeText(char[] cbuf,
                      int off,
                      int len)
               throws IOException

Specified by:

writeText in class ResponseWriter

Throws:

IOException

cloneWithWriter

public ResponseWriter cloneWithWriter(Writer writer)

Specified by:

cloneWithWriter in class ResponseWriter

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

write

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

Specified by:

write in class Writer

Throws:

IOException

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

writeText

public void writeText(Object object,
                      UIComponent component,
                      String string)
               throws IOException

This method ignores the UIComponent provided and simply calls writeText(Object,String)

Overrides:

writeText in class ResponseWriter

Throws:

IOException

Since:

1.2

getInternalBuffer

protected StreamCharBuffer getInternalBuffer()

getInternalBuffer

protected StreamCharBuffer getInternalBuffer(boolean reset)

getFacesContext

protected FacesContext getFacesContext()

getWrapScriptContentWithXmlCommentTag

protected boolean getWrapScriptContentWithXmlCommentTag()

forceFlush

protected void forceFlush()
                   throws IOException

Throws:

IOException