org.apache.myfaces.tobago.webapp

Class TobagoResponseWriter

java.lang.Object

java.io.Writer

javax.faces.context.ResponseWriter

org.apache.myfaces.tobago.webapp.TobagoResponseWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

DebugResponseWriterWrapper, TobagoResponseWriterBase, TobagoResponseWriterWrapper

public abstract class TobagoResponseWriter
extends javax.faces.context.ResponseWriter

This provides an alternative ResponseWriter interfaces, which allows optimizations. E. g. some attributes needed to to be escaped.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
TobagoResponseWriter()

Method Summary

Modifier and Type	Method and Description
abstract javax.faces.context.ResponseWriter	cloneWithWriter(Writer writer)
void	endCDATA()
abstract void	endElement(HtmlElements name)
abstract void	endElement(String name) Deprecated. Should not directly called via this interface. There is be a special method which might be better.
void	endJavascript() Deprecated. Should not be used, because it conflicts with CSP.
abstract void	flush()
String	getContentTypeWithCharSet()
void	startCDATA()
abstract void	startElement(HtmlElements name)
abstract void	startElement(String name, javax.faces.component.UIComponent component) Deprecated. Should not directly called via this interface. There is be a special method which might be better.
void	startJavascript() Deprecated. Should not be used, because it conflicts with CSP.
abstract void	write(String string)
void	writeAttribute(MarkupLanguageAttributes name, boolean on) Writes a boolean attribute.
abstract void	writeAttribute(MarkupLanguageAttributes name, HtmlTypes type)
void	writeAttribute(MarkupLanguageAttributes name, Integer number) Writes a Integer attribute, if the value is not null.
abstract void	writeAttribute(MarkupLanguageAttributes name, String string, boolean escape) Writes a string attribute.
abstract void	writeAttribute(String name, Object value, String property) Deprecated. Should not directly called via this interface. There is be a special method which might be better.
void	writeClassAttribute(CssItem first) Write the class attribute.
void	writeClassAttribute(CssItem first, CssItem second) Write the class attribute.
void	writeClassAttribute(CssItem first, CssItem second, CssItem... others) Write the class attribute.
void	writeCommandMapAttribute(String map) Write the command map data attribute.
abstract void	writeComment(Object comment)
void	writeIcon(Icons icon, CssItem... cssItems) Writes an supported icon.
void	writeIcon(Icons icon, Style style, CssItem... cssItems) Writes an supported icon with explicit style information.
void	writeIdAttribute(String id) Write the id attribute.
void	writeJavascript(String script) Deprecated. Should not be used, because it conflicts with CSP.
void	writeNameAttribute(String name) Write the name attribute.
void	writeStyleAttribute(String style) Deprecated. since 1.5.0, use writeStyleAttribute(Style) instead.
void	writeStyleAttribute(Style style) Write the style attribute.
abstract void	writeText(Object text, String property) Deprecated. Should not directly called via this interface. There is be a special method which might be better.
void	writeText(String text) Write text content.
abstract void	writeURIAttribute(MarkupLanguageAttributes name, String string) Writes a string attribute URL encoded.
abstract void	writeURIAttribute(String name, Object value, String property) Deprecated. Should not directly called via this interface. There is be a special method which might be better.

Methods inherited from class javax.faces.context.ResponseWriter

endDocument, getCharacterEncoding, getContentType, startDocument, writeText, writeText

Methods inherited from class java.io.Writer

append, append, append, close, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TobagoResponseWriter

public TobagoResponseWriter()

Method Detail

startElement

@Deprecated
public abstract void startElement(String name,
                                              javax.faces.component.UIComponent component)
                                       throws IOException

Deprecated. Should not directly called via this interface. There is be a special method which might be better.

Specified by:

startElement in class javax.faces.context.ResponseWriter

Throws:

IOException

startElement

public abstract void startElement(HtmlElements name)
                           throws IOException

Throws:

IOException

endElement

@Deprecated
public abstract void endElement(String name)
                                     throws IOException

Deprecated. Should not directly called via this interface. There is be a special method which might be better.

Specified by:

endElement in class javax.faces.context.ResponseWriter

Throws:

IOException

endElement

public abstract void endElement(HtmlElements name)
                         throws IOException

Throws:

IOException

write

public abstract void write(String string)
                    throws IOException

Overrides:

write in class Writer

Throws:

IOException

writeComment

public abstract void writeComment(Object comment)
                           throws IOException

Specified by:

writeComment in class javax.faces.context.ResponseWriter

Throws:

IOException

cloneWithWriter

public abstract javax.faces.context.ResponseWriter cloneWithWriter(Writer writer)

Specified by:

cloneWithWriter in class javax.faces.context.ResponseWriter

writeAttribute

@Deprecated
public abstract void writeAttribute(String name,
                                                Object value,
                                                String property)
                                         throws IOException

Deprecated. Should not directly called via this interface. There is be a special method which might be better.

Specified by:

writeAttribute in class javax.faces.context.ResponseWriter

Throws:

IOException

writeURIAttribute

@Deprecated
public abstract void writeURIAttribute(String name,
                                                   Object value,
                                                   String property)
                                            throws IOException

Deprecated. Should not directly called via this interface. There is be a special method which might be better.

Specified by:

writeURIAttribute in class javax.faces.context.ResponseWriter

Throws:

IOException

writeText

@Deprecated
public abstract void writeText(Object text,
                                           String property)
                                    throws IOException

Deprecated. Should not directly called via this interface. There is be a special method which might be better.

Specified by:

writeText in class javax.faces.context.ResponseWriter

Throws:

IOException

flush

public abstract void flush()
                    throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class javax.faces.context.ResponseWriter

Throws:

IOException

writeAttribute

public abstract void writeAttribute(MarkupLanguageAttributes name,
                                    String string,
                                    boolean escape)
                             throws IOException

Writes a string attribute. The renderer may set escape=false to switch of escaping of the string, if it is not necessary.

Throws:

IOException

writeAttribute

public abstract void writeAttribute(MarkupLanguageAttributes name,
                                    HtmlTypes type)
                             throws IOException

Throws:

IOException

writeURIAttribute

public abstract void writeURIAttribute(MarkupLanguageAttributes name,
                                       String string)
                                throws IOException

Writes a string attribute URL encoded.

Throws:

IOException

writeAttribute

public void writeAttribute(MarkupLanguageAttributes name,
                           boolean on)
                    throws IOException

Writes a boolean attribute. The value will not escaped.

Throws:

IOException

writeAttribute

public void writeAttribute(MarkupLanguageAttributes name,
                           Integer number)
                    throws IOException

Writes a Integer attribute, if the value is not null. The value will not be escaped.

Throws:

IOException

writeIdAttribute

public void writeIdAttribute(String id)
                      throws IOException

Write the id attribute. The value will not escaped.

Throws:

IOException

writeNameAttribute

public void writeNameAttribute(String name)
                        throws IOException

Write the name attribute. The value will not escaped.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem first)
                         throws IOException

Write the class attribute. The value will not escaped.

Throws:

IOException

writeCommandMapAttribute

public void writeCommandMapAttribute(String map)
                              throws IOException

Write the command map data attribute.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem first,
                                CssItem second)
                         throws IOException

Write the class attribute. The value will not escaped.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem first,
                                CssItem second,
                                CssItem... others)
                         throws IOException

Write the class attribute. The value will not escaped.

Throws:

IOException

writeStyleAttribute

public void writeStyleAttribute(Style style)
                         throws IOException

Write the style attribute. The value may be escaped (depending of the content).

Throws:

IOException

writeStyleAttribute

@Deprecated
public void writeStyleAttribute(String style)
                                     throws IOException

Deprecated. since 1.5.0, use writeStyleAttribute(Style) instead.

Write the style attribute. The value will not escaped.

Throws:

IOException

writeIcon

public void writeIcon(Icons icon,
                      CssItem... cssItems)
               throws IOException

Writes an supported icon.

Throws:

IOException

writeIcon

public void writeIcon(Icons icon,
                      Style style,
                      CssItem... cssItems)
               throws IOException

Writes an supported icon with explicit style information.

Throws:

IOException

writeJavascript

@Deprecated
public void writeJavascript(String script)
                                 throws IOException

Deprecated. Should not be used, because it conflicts with CSP.

Throws:

IOException

endJavascript

@Deprecated
public void endJavascript()
                               throws IOException

Deprecated. Should not be used, because it conflicts with CSP.

Throws:

IOException

startJavascript

@Deprecated
public void startJavascript()
                                 throws IOException

Deprecated. Should not be used, because it conflicts with CSP.

Throws:

IOException

writeText

public void writeText(String text)
               throws IOException

Write text content. The text will be escaped.

Throws:

IOException

getContentTypeWithCharSet

public String getContentTypeWithCharSet()

startCDATA

public void startCDATA()
                throws IOException

Overrides:

startCDATA in class javax.faces.context.ResponseWriter

Throws:

IOException

endCDATA

public void endCDATA()
              throws IOException

Overrides:

endCDATA in class javax.faces.context.ResponseWriter

Throws:

IOException