Package freemarker.core
Class OutputFormat
java.lang.Object
freemarker.core.OutputFormat
- Direct Known Subclasses:
CSSOutputFormat
,JavaScriptOutputFormat
,JSONOutputFormat
,MarkupOutputFormat
,PlainTextOutputFormat
,UndefinedOutputFormat
Represents an output format. If you need auto-escaping, see its subclass,
MarkupOutputFormat
.- Since:
- 2.3.24
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract String
Returns the MIME type of the output format.abstract String
getName()
The short name used to refer to this format (like in the#ftl
header).abstract boolean
Tells if this output format allows insertingTemplateMarkupOutputModel
-s of another output formats into it.final String
toString()
Returns the short description of this format, to be used in error messages.protected String
Should 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#ftl
header). -
getMimeType
Returns the MIME type of the output format. This might comes handy when generating a HTTP response.null
null
if 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. Iftrue
, the foreignTemplateMarkupOutputModel
will be inserted into the output as is (like 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 returnsfalse
(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.)true
value 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.
-