/*
* Eoulsan development code
*
* This code may be freely distributed and modified under the
* terms of the GNU Lesser General Public License version 2.1 or
* later and CeCILL-C. This should be distributed with the code.
* If you do not have a copy, see:
*
* http://www.gnu.org/licenses/lgpl-2.1.txt
* http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt
*
* Copyright for this code is held jointly by the Genomic platform
* of the Institut de Biologie de l'École normale supérieure and
* the individual authors. These should be listed in @author doc
* comments.
*
* For more information on the Eoulsan project and its aims,
* or to join the Eoulsan Google group, visit the home page
* at:
*
* http://outils.genomique.biologie.ens.fr/eoulsan
*
*/
package fr.ens.biologie.genomique.eoulsan.core;
import java.util.HashSet;
import java.util.Set;
import fr.ens.biologie.genomique.eoulsan.EoulsanRuntimeException;
import fr.ens.biologie.genomique.eoulsan.data.DataFormat;
import fr.ens.biologie.genomique.eoulsan.io.CompressionType;
/**
* This class allow to easily create input ports for a step.
* @since 2.0
* @author Laurent Jourdren
*/
public class OutputPortsBuilder {
/** Default single output port name. */
public static final String DEFAULT_SINGLE_OUTPUT_PORT_NAME = "output";
private final Set<OutputPort> result = new HashSet<>();
private final Set<String> portNames = new HashSet<>();
/**
* Add an output port.
* @param name name of the port
* @param format format of the port
*/
public OutputPortsBuilder addPort(final String name,
final DataFormat format) {
return addPort(new SimpleOutputPort(name, format));
}
/**
* Add an output port.
* @param name name of the port
* @param list true if a list is excepted as port value
* @param format format of the port
*/
public OutputPortsBuilder addPort(final String name, final boolean list,
final DataFormat format) {
return addPort(new SimpleOutputPort(name, list, format));
}
/**
* Add an output port.
* @param name name of the port
* @param format format of the port
* @param compression compression of the output
*/
public OutputPortsBuilder addPort(final String name, final DataFormat format,
final CompressionType compression) {
return addPort(new SimpleOutputPort(name, format, compression));
}
/**
* Add an output port.
* @param name name of the port
* @param list true if a list is excepted as port value
* @param format format of the port
* @param compression compression of the output
*/
public OutputPortsBuilder addPort(final String name, final boolean list,
final DataFormat format, final CompressionType compression) {
return addPort(new SimpleOutputPort(name, list, format, compression));
}
/**
* Create the ports.
* @return new OutputPorts object
*/
public OutputPorts create() {
return new SimpleOutputPorts(this.result);
}
/**
* Create the ports with no ports.
* @return a new OutputPorts object
*/
public static final OutputPorts noOutputPort() {
return new SimpleOutputPorts(null);
}
/**
* Convenient method to create the ports with only one port.
* @return a new OutputPorts object
*/
public static final OutputPorts singleOutputPort(final DataFormat format) {
return new OutputPortsBuilder()
.addPort(DEFAULT_SINGLE_OUTPUT_PORT_NAME, format).create();
}
/**
* Convenient method to create the ports with only one port.
* @return a new OutputPorts object
*/
public static final OutputPorts singleOutputPort(final String name,
final DataFormat format) {
return new OutputPortsBuilder().addPort(name, format).create();
}
/**
* Convenient method to create a defensive copy of an OutputPorts object.
* @param ports an existing OutputPorts object
* @return a new OutputPorts object or null if the ports parameter is null
*/
public static final OutputPorts copy(final OutputPorts ports) {
if (ports == null) {
return null;
}
final OutputPortsBuilder builder = new OutputPortsBuilder();
for (OutputPort port : ports) {
builder.addPort(port);
}
return builder.create();
}
//
// Other method
//
private OutputPortsBuilder addPort(final OutputPort port) {
if (this.portNames.contains(port.getName())) {
throw new EoulsanRuntimeException(
"Two output ports had the same name: " + port.getName());
}
this.result.add(port);
this.portNames.add(port.getName());
return this;
}
}