Package org.apache.myfaces.tobago.webapp
Class TobagoResponseWriter
- java.lang.Object
-
- java.io.Writer
-
- jakarta.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 jakarta.faces.context.ResponseWriterThis provides an alternative ResponseWriter interfaces, which allows optimizations. E. g. some attributes needed to to be escaped.
-
-
Constructor Summary
Constructors Constructor Description TobagoResponseWriter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract jakarta.faces.context.ResponseWritercloneWithWriter(Writer writer)voidendCDATA()abstract voidendElement(String name)Deprecated.Should not directly called via this interface.abstract voidendElement(HtmlElements name)abstract voidflush()StringgetContentTypeWithCharSet()voidstartCDATA()abstract voidstartElement(String name, jakarta.faces.component.UIComponent component)Deprecated.Should not directly called via this interface.abstract voidstartElement(HtmlElements name)abstract voidstartElement(HtmlElements name, jakarta.faces.component.UIComponent component)abstract voidwrite(String string)abstract voidwriteAttribute(String name, Object value, String property)Deprecated.since 1.0.11, should not directly called via this interface.voidwriteAttribute(MarkupLanguageAttributes name, boolean on)Writes a boolean attribute.voidwriteAttribute(MarkupLanguageAttributes name, Integer number)Writes aIntegerattribute, if the value is notnull.abstract voidwriteAttribute(MarkupLanguageAttributes name, String string, boolean escape)Writes a string attribute.abstract voidwriteAttribute(MarkupLanguageAttributes name, HtmlTypes type)voidwriteClassAttribute(CssItem... first)Write the class attribute.voidwriteClassAttribute(CssItem first, CssItem[] second, CssItem... third)Write the class attribute.voidwriteClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem... fourth)Write the class attribute.voidwriteClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem... fifth)Write the class attribute.voidwriteClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem[] fifth, CssItem... sixth)voidwriteCommandMapAttribute(String map)abstract voidwriteComment(Object comment)voidwriteIdAttribute(String id)Write the id attribute.voidwriteNameAttribute(String name)Write the name attribute.abstract voidwriteText(Object text, String property)Deprecated.Should not directly called via this interface.voidwriteText(String text)Write text content.abstract voidwriteURIAttribute(String name, Object value, String property)Deprecated.since 1.0.11, should not directly called via this interface.abstract voidwriteURIAttribute(MarkupLanguageAttributes name, String string)Writes a string attribute URL encoded.-
Methods inherited from class jakarta.faces.context.ResponseWriter
endDocument, getCharacterEncoding, getContentType, startDocument, writeDoctype, writePreamble, writeText, writeText
-
-
-
-
Method Detail
-
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.- Specified by:
startElementin classjakarta.faces.context.ResponseWriter- 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.Should not directly called via this interface. There is be a special method which might be better.- Specified by:
endElementin classjakarta.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:
writein classWriter- Throws:
IOException
-
writeComment
public abstract void writeComment(Object comment) throws IOException
- Specified by:
writeCommentin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
cloneWithWriter
public abstract jakarta.faces.context.ResponseWriter cloneWithWriter(Writer writer)
- Specified by:
cloneWithWriterin classjakarta.faces.context.ResponseWriter
-
writeAttribute
@Deprecated public abstract void writeAttribute(String name, Object value, String property) throws IOException
Deprecated.since 1.0.11, should not directly called via this interface. There is be a special method which might be better.- Specified by:
writeAttributein classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
writeURIAttribute
@Deprecated public abstract void writeURIAttribute(String name, Object value, String property) throws IOException
Deprecated.since 1.0.11, should not directly called via this interface. There is be a special method which might be better.- Specified by:
writeURIAttributein classjakarta.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:
writeTextin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
flush
public abstract void flush() throws IOException- Specified by:
flushin interfaceFlushable- Specified by:
flushin classjakarta.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 aIntegerattribute, if the value is notnull. 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 public void writeCommandMapAttribute(String map) throws IOException
Deprecated.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- Overrides:
startCDATAin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
endCDATA
public void endCDATA() throws IOException- Overrides:
endCDATAin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
-