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.ResponseWriter
This provides an alternative ResponseWriter interfaces, which allows optimizations. E.g. some attributes needed to to be escaped.
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract jakarta.faces.context.ResponseWritercloneWithWriter(Writer writer) voidendCDATA()abstract voidendElement(String name) Deprecated.This should not be called directly via this interface.abstract voidendElement(HtmlElements name) abstract voidflush()voidabstract 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 voidabstract voidwriteAttribute(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.voidwriteAttribute(MarkupLanguageAttributes name, boolean on) Writes a boolean attribute.voidwriteAttribute(MarkupLanguageAttributes name, Integer number) Writes aIntegerattribute, if the value is notnull.voidwriteAttribute(MarkupLanguageAttributes name, Long number) Writes aLongattribute, 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) voidDeprecated, for removal: This API element is subject to removal in a future version.abstract voidwriteComment(Object comment) voidWrite the id attribute.voidwriteNameAttribute(String name) Write the name attribute.abstract voidDeprecated.This should not be called directly via this interface.voidWrite text content.abstract voidwriteURIAttribute(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 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
-
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.- 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
- Throws:
IOException
-
endElement
Deprecated.This should not be called directly via this interface. A specific method is available that might be more suitable.- Specified by:
endElementin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
endElement
- Throws:
IOException
-
write
- Overrides:
writein classWriter- Throws:
IOException
-
writeComment
- Specified by:
writeCommentin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
cloneWithWriter
- Specified by:
cloneWithWriterin classjakarta.faces.context.ResponseWriter
-
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.- Specified by:
writeAttributein classjakarta.faces.context.ResponseWriter- 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.- Specified by:
writeURIAttributein classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
writeText
Deprecated.This should not be called directly via this interface. A specific method is available that might be more suitable.- Specified by:
writeTextin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
flush
- 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
Writes a boolean attribute. The value will not escaped.- Throws:
IOException
-
writeAttribute
Writes aIntegerattribute, if the value is notnull. The value will not be escaped.- Throws:
IOException
-
writeAttribute
Writes aLongattribute, if the value is notnull. The value will not be escaped.- Throws:
IOException
-
writeIdAttribute
Write the id attribute. The value will not escaped.- Throws:
IOException
-
writeNameAttribute
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.Write the command map data attribute.- Throws:
IOException
-
writeClassAttribute
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
Write text content. The text will be escaped.- Throws:
IOException
-
getContentTypeWithCharSet
-
startCDATA
- Overrides:
startCDATAin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-
endCDATA
- Overrides:
endCDATAin classjakarta.faces.context.ResponseWriter- Throws:
IOException
-