org.dita.dost

Class Processor

java.lang.Object

org.dita.dost.Processor

public final class Processor
extends java.lang.Object

DITA-OT processer. Not thread-safe, but can be reused.

Method Summary

Modifier and Type	Method and Description
Processor	cleanOnFailure(boolean cleanOnFailure) Clean temporary directory when process fails.
Processor	createDebugLog(boolean createDebugLog) Write a debug log to temporary directory.
void	run() Run process
Processor	setInput(java.io.File input) Set input document.
Processor	setInput(java.net.URI input) Set input document.
Processor	setLogger(org.slf4j.Logger logger) Set process logger
Processor	setMode(Configuration.Mode mode) Set error recovery mode.
Processor	setOutputDir(java.io.File output) Set output directory.
Processor	setOutputDir(java.net.URI output) Set output directory.
Processor	setProperties(java.util.Map<java.lang.String,java.lang.String> value) Set properties.
Processor	setProperty(java.lang.String name, java.lang.String value) Set property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setInput

public Processor setInput(java.io.File input)

Set input document.

Parameters:

input - input document file

Returns:

this Process object

setInput

public Processor setInput(java.net.URI input)

Set input document.

Parameters:

input - absolute input document URI

Returns:

this Process object

setOutputDir

public Processor setOutputDir(java.io.File output)

Set output directory.

Parameters:

output - absolute output directory

Returns:

this Process object

setOutputDir

public Processor setOutputDir(java.net.URI output)

Set output directory.

Parameters:

output - absolute output directory URI

Returns:

this Process object

setProperty

public Processor setProperty(java.lang.String name,
                             java.lang.String value)

Set property. Existing property mapping will be overridden.

Parameters:

name - property name

value - property value

Returns:

this Process object

setProperties

public Processor setProperties(java.util.Map<java.lang.String,java.lang.String> value)

Set properties. Existing property mapping will be overridden.

Parameters:

value - property mappings

Returns:

this Process object

setLogger

public Processor setLogger(org.slf4j.Logger logger)

Set process logger

Parameters:

logger - process logger

Returns:

this Process object

cleanOnFailure

public Processor cleanOnFailure(boolean cleanOnFailure)

Clean temporary directory when process fails. By default temporary directory is always cleaned.

Parameters:

cleanOnFailure - clean on failure

Returns:

this Process object

createDebugLog

public Processor createDebugLog(boolean createDebugLog)

Write a debug log to temporary directory. The name of the debug log is temporary file with .log extension. By default debug log is generated

Parameters:

createDebugLog - create debug log

Returns:

this Process object

setMode

public Processor setMode(Configuration.Mode mode)

Set error recovery mode.

Parameters:

mode - processing mode

Returns:

this Process object

run

public void run()
         throws DITAOTException

Run process

Throws:

DITAOTException - if processing failed