| Package | com.adobe.livecycle.assembler.client |
| Class | public class AssemblerOptionSpec |
| Inheritance | AssemblerOptionSpec  Object
|
AssemblerOptionSpec is the container for the "environment" options for a DDX job. Current environment parameters include the job log level, the default font, and flags to indicate if the DDX job is a validation-only test or if it should fail at the first sign of trouble.
| Method | Defined by | ||
|---|---|---|---|
| AssemblerOptionSpec | |||
|
String getDefaultFontStyle()
Retrieves the default font style.
| AssemblerOptionSpec | ||
|
String getLogLevel()
Retrieves the log level.
| AssemblerOptionSpec | ||
|
boolean isFailOnError()
Determines whether the DDX job should exit immediately when an
Exception or other error occurs. | AssemblerOptionSpec | ||
|
boolean isValidateOnly()
Determines whether the DDX job is a validation-only test.
| AssemblerOptionSpec | ||
|
void setDefaultFontStyle(String defaultFontStyle)
Sets a default font style to use when none is specified in the DDX.
| AssemblerOptionSpec | ||
|
void setFailOnError(boolean failOnError)
Sets whether the DDX job should exit immediately when an
Exception or other error occurs. | AssemblerOptionSpec | ||
|
void setLogLevel(String logLevel)
Sets the log level.
| AssemblerOptionSpec | ||
|
void setValidateOnly(boolean validateOnly)
Sets whether the DDX job is a validation-only test, which means that Assembler should validate the DDX but not execute it.
| AssemblerOptionSpec | ||
| AssemblerOptionSpec | () |
public AssemblerOptionSpec()
| getDefaultFontStyle | () |
public String getDefaultFontStyle()Retrieves the default font style.
ReturnsA java.lang.String containing the default font style. |
| getLogLevel | () |
public String getLogLevel()Retrieves the log level.
ReturnsA String containing the log level. |
| isFailOnError | () |
public boolean isFailOnError()Determines whether the DDX job should exit immediately when an Exception or other error occurs.
true if the DDX job should exit immediately when an Exception or other error occurs, false otherwise. |
| isValidateOnly | () |
public boolean isValidateOnly()Determines whether the DDX job is a validation-only test.
Returnstrue if the DDX job is a validation-only test, false otherwise. |
| setDefaultFontStyle | () |
public void setDefaultFontStyle(String defaultFontStyle)Sets a default font style to use when none is specified in the DDX.
Parameters
defaultFontStyle — The default font style to be set. The font style is the same format as the font attribute for DDX rich text elements: "font: <font-style> <font-weight> <font-size>/<line-height> <font-family-specifier>". Note that if the <font-family-specifier> contains any spaces, it should be surrounded with single quotes. For example, 'Minion Pro'. If no default is ever specified, a default of "font: normal normal 12pt 'Minion Pro'" is used. |
| setFailOnError | () |
public void setFailOnError(boolean failOnError)Sets whether the DDX job should exit immediately when an Exception or other error occurs.
Parameters
failOnError — A value of true means that the job will terminate upon an error or exception condition and throw the corresponding Throwable exception. A value of false means that the job will terminate the current DDX result block, store the Throwable exception in the output map, and attempt to execute any remaining result blocks. The default is true, meaning that the first error will terminate the DDX job immediately. |
| setLogLevel | () |
public void setLogLevel(String logLevel)Sets the log level. The log level can be set to an integer string or to one of 9 string values that have integer equivalents:
If the log level is not set, then it defaults to "INFO". For investigation of problems, it can be set to "FINE", "FINER" or "FINEST", but performance will be negatively affected in this mode.
Parameters
logLevel — The log level to be set. This is the string representation of a java.util.logging.Level value. |
| setValidateOnly | () |
public void setValidateOnly(boolean validateOnly)Sets whether the DDX job is a validation-only test, which means that Assembler should validate the DDX but not execute it.
Parameters
validateOnly — A value of true halts processing of the DDX after the DDX has been parsed and verified to be in compliance with the schema and application validation rules. In this case the result map will be null, and the input map is allowed to be empty or null since the input data streams are not evaluated until actually used during job execution. The default is false, meaning that normal processing will be performed. |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/assembler/client/AssemblerOptionSpec.html