org.daisy.pipeline.script

Class ScriptInput

java.lang.Object

org.daisy.pipeline.script.ScriptInput

public class ScriptInput
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptInput.Builder

Method Summary

Modifier and Type	Method and Description
Iterable<Source>	getInput(String port) Get all documents on an input port.
Iterable<String>	getOption(String name) Get the sequence of values for an option.
JobResources	getResources() Get the resource collection.
ScriptInput	storeToDisk()
ScriptInput	storeToDisk(File baseDir) Ensure all documents on input ports are stored to disk

Methods inherited from class java.lang.Object

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

Method Detail

getInput

public Iterable<Source> getInput(String port)

Get all documents on an input port. The returned Source should only be consumed once.

getOption

public Iterable<String> getOption(String name)

Get the sequence of values for an option.

getResources

public JobResources getResources()

Get the resource collection.

storeToDisk

public ScriptInput storeToDisk(File baseDir)
                        throws IOException

Ensure all documents on input ports are stored to disk

Parameters:

baseDir - The directory does not have to exist yet, and may be null, in which case a temporary directory will be created.

Throws:

IOException

storeToDisk

public ScriptInput storeToDisk()
                        throws IOException

Throws:

IOException