public class Options
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTES |
static java.lang.String |
BACKEND |
static java.lang.String |
BASEDIR |
static java.lang.String |
COMPACT |
static java.lang.String |
DESTINATION_DIR |
static java.lang.String |
DOCTYPE |
static java.lang.String |
ERUBY |
static java.lang.String |
HEADER_FOOTER |
static java.lang.String |
IN_PLACE |
static java.lang.String |
MKDIRS |
static java.lang.String |
PARSE_HEADER_ONLY |
static java.lang.String |
SAFE |
static java.lang.String |
SOURCE |
static java.lang.String |
TEMPLATE_CACHE |
static java.lang.String |
TEMPLATE_DIRS |
static java.lang.String |
TEMPLATE_ENGINE |
static java.lang.String |
TO_DIR |
static java.lang.String |
TO_FILE |
Constructor and Description |
---|
Options() |
Options(java.util.Map<java.lang.String,java.lang.Object> options) |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.lang.Object> |
map() |
void |
setAttributes(Attributes attributes) |
void |
setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes) |
void |
setBackend(java.lang.String backend) |
void |
setBaseDir(java.lang.String baseDir) |
void |
setCompact(boolean compact) |
void |
setDestinationDir(java.lang.String destinationDir) |
void |
setDocType(java.lang.String docType) |
void |
setEruby(java.lang.String eruby) |
void |
setHeaderFooter(boolean headerFooter)
Toggle including header and footer into the output.
|
void |
setInPlace(boolean inPlace) |
void |
setMkDirs(boolean mkDirs) |
void |
setOption(java.lang.String optionName,
java.lang.Object optionValue) |
void |
setParseHeaderOnly(boolean parseHeaderOnly) |
void |
setSafe(SafeMode safeMode)
Safe method calls safeMode.getLevel() to put the required level.
|
void |
setTemplateCache(boolean templateCache) |
void |
setTemplateDirs(java.lang.String... templateDirs) |
void |
setTemplateEngine(java.lang.String templateEngine) |
void |
setToDir(java.lang.String toDir) |
void |
setToFile(boolean toFile)
Toogle writing output to a file.
|
void |
setToFile(java.lang.String toFile)
Enable writing output to a file.
|
public static final java.lang.String IN_PLACE
public static final java.lang.String ATTRIBUTES
public static final java.lang.String HEADER_FOOTER
public static final java.lang.String TEMPLATE_DIRS
public static final java.lang.String TEMPLATE_ENGINE
public static final java.lang.String TO_FILE
public static final java.lang.String TO_DIR
public static final java.lang.String MKDIRS
public static final java.lang.String SAFE
public static final java.lang.String ERUBY
public static final java.lang.String COMPACT
public static final java.lang.String DESTINATION_DIR
public static final java.lang.String BACKEND
public static final java.lang.String DOCTYPE
public static final java.lang.String BASEDIR
public static final java.lang.String TEMPLATE_CACHE
public static final java.lang.String SOURCE
public static final java.lang.String PARSE_HEADER_ONLY
public Options()
public Options(java.util.Map<java.lang.String,java.lang.Object> options)
public void setInPlace(boolean inPlace)
public void setAttributes(Attributes attributes)
public void setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
public void setHeaderFooter(boolean headerFooter)
headerFooter
- If true, include header and footer into the output,
otherwise exclude them. This overrides any output-specific defaults.
public void setTemplateDirs(java.lang.String... templateDirs)
public void setTemplateEngine(java.lang.String templateEngine)
public void setToFile(java.lang.String toFile)
toFile
- The path to the output file. If the path is not absolute, it is
interpreted relative to what was set via #setToDir()
or #setBaseDir()
, in that order.public void setToFile(boolean toFile)
toFile
- If true, write output to a file in the same directory
as the input file, including header and footer into the output. If
false
, return output as a string without any header or
footer. The default header and footer visibility can be overridden
using #setHeaderFooter()
.
public void setToDir(java.lang.String toDir)
public void setMkDirs(boolean mkDirs)
public void setSafe(SafeMode safeMode)
safeMode
- enum.public void setEruby(java.lang.String eruby)
public void setCompact(boolean compact)
public void setDestinationDir(java.lang.String destinationDir)
public void setBackend(java.lang.String backend)
public void setDocType(java.lang.String docType)
public void setBaseDir(java.lang.String baseDir)
public void setTemplateCache(boolean templateCache)
public void setParseHeaderOnly(boolean parseHeaderOnly)
public void setOption(java.lang.String optionName, java.lang.Object optionValue)
public java.util.Map<java.lang.String,java.lang.Object> map()