org.daisy.pipeline.script

Class Script.Builder

java.lang.Object

org.daisy.pipeline.script.Script.Builder

Direct Known Subclasses:

XProcScript.Builder

Enclosing class:

Script

protected abstract static class Script.Builder
extends Object

Builder for Script objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected String	homepage
protected String	id
protected List<String>	inputFilesets
protected Map<String,ScriptPort>	inputPorts
protected Map<String,ScriptOption>	options
protected List<String>	outputFilesets
protected Map<String,ScriptPort>	outputPorts
protected String	shortName
protected String	version

Constructor Summary

Constructors

Constructor and Description
Builder(ScriptService<?> descriptor)
Builder(String id, String version)

Method Summary

Modifier and Type	Method and Description
abstract Script	build() Builds the Script instance.
Script.Builder	withDescription(String description) With description.
Script.Builder	withHomepage(String homepage) With homepage.
Script.Builder	withInputFileset(String fileset)
Script.Builder	withInputPort(String name, ScriptPort port) With input port
Script.Builder	withOption(String name, ScriptOption option) With option.
Script.Builder	withOutputFileset(String fileset)
Script.Builder	withOutputPort(String name, ScriptPort port) With output port
Script.Builder	withShortName(String shortName) With nice name.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

version

protected String version

shortName

protected String shortName

description

protected String description

homepage

protected String homepage

inputFilesets

protected List<String> inputFilesets

outputFilesets

protected List<String> outputFilesets

inputPorts

protected final Map<String,ScriptPort> inputPorts

outputPorts

protected final Map<String,ScriptPort> outputPorts

options

protected final Map<String,ScriptOption> options

Constructor Detail

Builder

public Builder(ScriptService<?> descriptor)

Builder

public Builder(String id,
               String version)

Method Detail

withInputFileset

public Script.Builder withInputFileset(String fileset)

withOutputFileset

public Script.Builder withOutputFileset(String fileset)

withShortName

public Script.Builder withShortName(String shortName)

With nice name.

withDescription

public Script.Builder withDescription(String description)

With description.

withHomepage

public Script.Builder withHomepage(String homepage)

With homepage.

withInputPort

public Script.Builder withInputPort(String name,
                                    ScriptPort port)

With input port

withOutputPort

public Script.Builder withOutputPort(String name,
                                     ScriptPort port)

With output port

withOption

public Script.Builder withOption(String name,
                                 ScriptOption option)

With option.

build

public abstract Script build()

Builds the Script instance.

Returns:

the Script