Package fr.ens.biologie.genomique.eoulsan.core

Class OutputPortsBuilder

java.lang.Object

fr.ens.biologie.genomique.eoulsan.core.OutputPortsBuilder

public class OutputPortsBuilder
extends Object

This class allow to easily create input ports for a step.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SINGLE_OUTPUT_PORT_NAME	Default single output port name.

Constructor Summary

Constructors

Constructor	Description
OutputPortsBuilder()

Method Summary

Modifier and Type	Method	Description
OutputPortsBuilder	addPort(String name, boolean list, DataFormat format)	Add an output port.
OutputPortsBuilder	addPort(String name, boolean list, DataFormat format, fr.ens.biologie.genomique.kenetre.io.CompressionType compression)	Add an output port.
OutputPortsBuilder	addPort(String name, DataFormat format)	Add an output port.
OutputPortsBuilder	addPort(String name, DataFormat format, fr.ens.biologie.genomique.kenetre.io.CompressionType compression)	Add an output port.
static OutputPorts	copy(OutputPorts ports)	Convenient method to create a defensive copy of an OutputPorts object.
OutputPorts	create()	Create the ports.
static OutputPorts	noOutputPort()	Create the ports with no ports.
static OutputPorts	singleOutputPort(DataFormat format)	Convenient method to create the ports with only one port.
static OutputPorts	singleOutputPort(String name, DataFormat format)	Convenient method to create the ports with only one port.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SINGLE_OUTPUT_PORT_NAME

public static final String DEFAULT_SINGLE_OUTPUT_PORT_NAME

Default single output port name.

See Also:

• Constant Field Values

Constructor Details

OutputPortsBuilder

public OutputPortsBuilder()

Method Details

addPort

public OutputPortsBuilder addPort(String name,
 DataFormat format)

Add an output port.

Parameters:

name - name of the port

format - format of the port

Returns:

the instance of the builder

addPort

public OutputPortsBuilder addPort(String name,
 boolean list,
 DataFormat format)

Add an output port.

Parameters:

name - name of the port

list - true if a list is excepted as port value

format - format of the port

Returns:

the instance of the builder

addPort

public OutputPortsBuilder addPort(String name,
 DataFormat format,
 fr.ens.biologie.genomique.kenetre.io.CompressionType compression)

Add an output port.

Parameters:

name - name of the port

format - format of the port

compression - compression of the output

Returns:

the instance of the builder

addPort

public OutputPortsBuilder addPort(String name,
 boolean list,
 DataFormat format,
 fr.ens.biologie.genomique.kenetre.io.CompressionType compression)

Add an output port.

Parameters:

name - name of the port

list - true if a list is excepted as port value

format - format of the port

compression - compression of the output

Returns:

the instance of the builder

create

public OutputPorts create()

Create the ports.

Returns:

new OutputPorts object

noOutputPort

public static OutputPorts noOutputPort()

Create the ports with no ports.

Returns:

a new OutputPorts object

singleOutputPort

public static OutputPorts singleOutputPort(DataFormat format)

Convenient method to create the ports with only one port.

Parameters:

format - format of the port

Returns:

a new OutputPorts object

singleOutputPort

public static OutputPorts singleOutputPort(String name,
 DataFormat format)

Convenient method to create the ports with only one port.

Parameters:

name - name of the port

format - format of the port

Returns:

a new OutputPorts object

copy

public static OutputPorts copy(OutputPorts ports)

Convenient method to create a defensive copy of an OutputPorts object.

Parameters:

ports - an existing OutputPorts object

Returns:

a new OutputPorts object or null if the ports parameter is null