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 String
DEFAULT_SINGLE_OUTPUT_PORT_NAME
Default single output port name.
-
Constructor Summary
Constructors Constructor Description OutputPortsBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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.
-
-
-
Field Detail
-
DEFAULT_SINGLE_OUTPUT_PORT_NAME
public static final String DEFAULT_SINGLE_OUTPUT_PORT_NAME
Default single output port name.- See Also:
- Constant Field Values
-
-
Method Detail
-
addPort
public OutputPortsBuilder addPort(String name, DataFormat format)
Add an output port.- Parameters:
name
- name of the portformat
- format of the port
-
addPort
public OutputPortsBuilder addPort(String name, boolean list, DataFormat format)
Add an output port.- Parameters:
name
- name of the portlist
- true if a list is excepted as port valueformat
- format of the port
-
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 portformat
- format of the portcompression
- compression of the output
-
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 portlist
- true if a list is excepted as port valueformat
- format of the portcompression
- compression of the output
-
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.- Returns:
- a new OutputPorts object
-
singleOutputPort
public static OutputPorts singleOutputPort(String name, DataFormat format)
Convenient method to create the ports with only one 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
-
-