Class TobagoResponseWriter

java.lang.Object

java.io.Writer

org.apache.myfaces.tobago.webapp.TobagoResponseWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

DebugResponseWriterWrapper, TobagoResponseWriterBase, TobagoResponseWriterWrapper

public abstract class TobagoResponseWriter
extends Writer

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

Field Summary

Fields inherited from class Writer

lock

Constructor Summary

Constructors

Constructor	Description
TobagoResponseWriter()

Method Summary

Modifier and Type	Method	Description
abstract jakarta.faces.context.ResponseWriter	cloneWithWriter(Writer writer)
void	endCDATA()
abstract void	endDocument()
abstract void	endElement(String name)	Deprecated. This should not be called directly via this interface.
abstract void	endElement(HtmlElements name)
abstract void	flush()
abstract String	getCharacterEncoding()
abstract String	getContentType()
String	getContentTypeWithCharSet()
void	startCDATA()
abstract void	startDocument()
abstract void	startElement(String name, jakarta.faces.component.UIComponent component)	Deprecated. Should not directly called via this interface.
abstract void	startElement(HtmlElements name)
abstract void	startElement(HtmlElements name, jakarta.faces.component.UIComponent component)
abstract void	write(String string)
abstract void	writeAttribute(String name, Object value, String property)	Deprecated, for removal: This API element is subject to removal in a future version. This should not be called directly via this interface.
void	writeAttribute(MarkupLanguageAttributes name, boolean on)	Writes a boolean attribute.
void	writeAttribute(MarkupLanguageAttributes name, Integer number)	Writes a Integer attribute, if the value is not null.
void	writeAttribute(MarkupLanguageAttributes name, Long number)	Writes a Long attribute, if the value is not null.
abstract void	writeAttribute(MarkupLanguageAttributes name, String string, boolean escape)	Writes a string attribute.
abstract void	writeAttribute(MarkupLanguageAttributes name, HtmlTypes type)
void	writeClassAttribute(CssItem... first)	Write the class attribute.
void	writeClassAttribute(CssItem first, CssItem[] second, CssItem... third)	Write the class attribute.
void	writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem... fourth)	Write the class attribute.
void	writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem... fifth)	Write the class attribute.
void	writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem[] fifth, CssItem... sixth)
void	writeCommandMapAttribute(String map)	Deprecated, for removal: This API element is subject to removal in a future version. Use RendererBase.encodeBehavior(TobagoResponseWriter, FacesContext, ClientBehaviorHolder) instead.
abstract void	writeComment(Object comment)
void	writeDoctype(String arg0)
void	writeIdAttribute(String id)	Write the id attribute.
void	writeNameAttribute(String name)	Write the name attribute.
void	writePreamble(String arg0)
abstract void	writeText(char[] arg0, int arg1, int arg2)
void	writeText(Object arg0, jakarta.faces.component.UIComponent arg1, String arg2)
abstract void	writeText(Object text, String property)	Deprecated. This should not be called directly via this interface.
void	writeText(String text)	Write text content.
abstract void	writeURIAttribute(String name, Object value, String property)	Deprecated, for removal: This API element is subject to removal in a future version. This should not be called directly via this interface.
abstract void	writeURIAttribute(MarkupLanguageAttributes name, String string)	Writes a string attribute URL encoded.

Methods inherited from class Writer

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

Methods inherited from class Object

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

Constructor Details

TobagoResponseWriter

public TobagoResponseWriter()

Method Details

startElement

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

Deprecated.

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

Throws:

IOException

startElement

public abstract void startElement(HtmlElements name,
 jakarta.faces.component.UIComponent component)
                           throws IOException

Throws:

IOException

startElement

public abstract void startElement(HtmlElements name)
                           throws IOException

Throws:

IOException

endElement

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

Deprecated.

This should not be called directly via this interface. A specific method is available that might be more suitable.

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

Throws:

IOException

cloneWithWriter

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

writeAttribute

@Deprecated(since="1.0.11",
            forRemoval=true)
public abstract void writeAttribute(String name,
 Object value,
 String property)
                             throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

This should not be called directly via this interface. A specific method is available that might be more suitable.

Throws:

IOException

writeURIAttribute

@Deprecated(since="1.0.11",
            forRemoval=true)
public abstract void writeURIAttribute(String name,
 Object value,
 String property)
                                throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

This should not be called directly via this interface. A specific method is available that might be more suitable.

Throws:

IOException

writeText

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

Deprecated.

This should not be called directly via this interface. A specific method is available that might be more suitable.

Throws:

IOException

flush

public abstract void flush()
                    throws IOException

Specified by:

flush in interface Flushable

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

writeAttribute

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

Writes a Long 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

writeCommandMapAttribute

@Deprecated(since="5.0.0",
            forRemoval=true)
public void writeCommandMapAttribute(String map)
                              throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Use RendererBase.encodeBehavior(TobagoResponseWriter, FacesContext, ClientBehaviorHolder) instead.

Write the command map data attribute.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem... first)
                         throws IOException

Write the class attribute. The value will not escaped.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem first,
 CssItem[] second,
 CssItem... third)
                         throws IOException

Write the class attribute. The value will not escaped.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem first,
 CssItem[] second,
 CssItem[] third,
 CssItem... fourth)
                         throws IOException

Write the class attribute. The value will not escaped.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem first,
 CssItem[] second,
 CssItem[] third,
 CssItem[] fourth,
 CssItem... fifth)
                         throws IOException

Write the class attribute. The value will not escaped.

Throws:

IOException

writeClassAttribute

public void writeClassAttribute(CssItem first,
 CssItem[] second,
 CssItem[] third,
 CssItem[] fourth,
 CssItem[] fifth,
 CssItem... sixth)
                         throws IOException

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

Throws:

IOException

endCDATA

public void endCDATA()
              throws IOException

Throws:

IOException

getContentType

public abstract String getContentType()

getCharacterEncoding

public abstract String getCharacterEncoding()

startDocument

public abstract void startDocument()
                            throws IOException

Throws:

IOException

endDocument

public abstract void endDocument()
                          throws IOException

Throws:

IOException

writeText

public abstract void writeText(char[] arg0,
 int arg1,
 int arg2)
                        throws IOException

Throws:

IOException

writeText

public void writeText(Object arg0,
 jakarta.faces.component.UIComponent arg1,
 String arg2)
               throws IOException

Throws:

IOException

writePreamble

public void writePreamble(String arg0)
                   throws IOException

Throws:

IOException

writeDoctype

public void writeDoctype(String arg0)
                  throws IOException

Throws:

IOException