Package com.io7m.xstructural.api
Interface XSProcessorRequestType
- All Known Implementing Classes:
XSProcessorRequest
@Immutable
public interface XSProcessorRequestType
A document processor request.
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classXSProcessorRequestType.StylesheetThe stylesheet that will be used during processing.static classXSProcessorRequestType.TaskA document processor task. -
Method Summary
Modifier and Type Method Description java.util.Optional<java.nio.file.Path>brandingFile()default voidcheckPreconditions()Check preconditions for the type.default java.nio.file.PathmessageFile()java.nio.file.PathoutputDirectory()java.nio.file.PathsourceFile()default XSProcessorRequestType.Stylesheetstylesheet()default XSProcessorRequestType.Tasktask()default java.nio.file.PathtraceFile()default booleanwriteResources()
-
Method Details
-
outputDirectory
java.nio.file.Path outputDirectory()- Returns:
- The directory to which output files will be written
-
sourceFile
java.nio.file.Path sourceFile()- Returns:
- The source document
-
task
- Returns:
- The task that will be executed
-
stylesheet
- Returns:
- The stylesheet that will be used
-
writeResources
@Default default boolean writeResources()- Returns:
trueif resources (such as CSS) should be copied into the output directory
-
traceFile
@Default default java.nio.file.Path traceFile()- Returns:
- The file to which trace messages will be written
-
messageFile
@Default default java.nio.file.Path messageFile()- Returns:
- The file to which XSLT messages will be written
-
brandingFile
java.util.Optional<java.nio.file.Path> brandingFile()- Returns:
- The branding file that will be included into output documents
-
checkPreconditions
@Check default void checkPreconditions()Check preconditions for the type.
-