Class OutputFormat
- Direct Known Subclasses:
CSSOutputFormat,JavaScriptOutputFormat,JSONOutputFormat,MarkupOutputFormat,PlainTextOutputFormat,UndefinedOutputFormat
MarkupOutputFormat.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract StringReturns the MIME type of the output format.abstract StringgetName()The short name used to refer to this format (like in the#ftlheader).abstract booleanTells if this output format allows insertingTemplateMarkupOutputModel-s of another output formats into it.toString()Returns the short description of this format, to be used in error messages.protected StringShould be like"foo=\"something\", bar=123"; this will be inserted inside the parentheses intoString().
-
Constructor Details
-
OutputFormat
public OutputFormat()
-
-
Method Details
-
getName
The short name used to refer to this format (like in the#ftlheader). -
getMimeType
Returns the MIME type of the output format. This might comes handy when generating a HTTP response.nullnullif this output format doesn't clearly corresponds to a specific MIME type. -
isOutputFormatMixingAllowed
public abstract boolean isOutputFormatMixingAllowed()Tells if this output format allows insertingTemplateMarkupOutputModel-s of another output formats into it.If
true, the foreignTemplateMarkupOutputModelwill be inserted into the output. If the current output format is aMarkupOutputFormatthis is done using theMarkupOutputFormat.outputForeign(TemplateMarkupOutputModel, Writer)method, which can implement smart conversions. The default behavior (and the only behavior for non-markup outputs) is to behave as if the surrounding output format was the same; this is usually a bad idea to allow, as such an event could indicate application bugs.If this method returns
false(recommended), then FreeMarker will try to assimilate the inserted value by converting its format to this format, which will currently (2.3.24) cause exception, unless the inserted value is made by escaping plain text and the target format is non-escaping, in which case format conversion is trivially possible. (It's not impossible that conversions will be extended beyond this, if there will be demand for that.)truevalue is used byUndefinedOutputFormat. -
toString
Returns the short description of this format, to be used in error messages. OverridetoStringExtraProperties()to customize this. -
toStringExtraProperties
Should be like"foo=\"something\", bar=123"; this will be inserted inside the parentheses intoString(). Shouldn't returnnull; should return""if there are no extra properties.
-