RXTXPortDriver.java

package kernel.serial_ports;

import gnu.io.CommPortIdentifier;
import kernel.serial_ports.comm_port_wrapper.PortIdentifierGetter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Vector;

public class RXTXPortDriver implements PortDriver {
    private static Logger log = LoggerFactory.getLogger(RXTXPortDriver.class);

    private final String applicationName;

    private final PortIdentifierGetter portWrapper;

    public RXTXPortDriver(
            String applicationName, PortIdentifierGetter portWrapper
    ){
        this.applicationName = applicationName;
        this.portWrapper = portWrapper;
    }

    @Override public String getApplicationName(){
        return this.applicationName;
    }

    @Override public List<String> getSerialPortNames(){
        Enumeration portIdentifiers = this.portWrapper.getPortIdentifiers();
        List<CommPortIdentifier> identifierList = castPortIdentifiersToList(
                portIdentifiers
        );
        List<CommPortIdentifier> serialPortList = filterForSerialPorts(
                identifierList
        );
        return getPortNamesForList(serialPortList);
    }

    @Override public SerialPort getPortByName(String portName) {
        return new RXTXPortWrapper(portName);
    }

    private static List<CommPortIdentifier> castPortIdentifiersToList(
            Enumeration commPortIdentifiers
    ){
        List<CommPortIdentifier> portIdentifierList = new Vector<>();
        CommPortIdentifier portIdentifier;

        while(commPortIdentifiers.hasMoreElements()){
            portIdentifier = castToPortIdentifier(
                commPortIdentifiers.nextElement()
            );
            portIdentifierList.add(portIdentifier);
        }

        return portIdentifierList;
    }

    private static CommPortIdentifier castToPortIdentifier(
            Object portIdentifier){
        return (CommPortIdentifier)(portIdentifier);
    }

    private List<CommPortIdentifier> filterForSerialPorts(
            List<CommPortIdentifier> identifierList){

        List<CommPortIdentifier> serialPorts = new ArrayList<>(
                identifierList.size()
        );

        for(CommPortIdentifier identifier: identifierList){
            if(identifier.getPortType() == CommPortIdentifier.PORT_SERIAL){
                writeLogEntryForSerialPort(identifier);
                serialPorts.add(identifier);
            }
        }

        return serialPorts;
    }

    private static List<String> getPortNamesForList(
        List<CommPortIdentifier> portIdentifiers
    ){
        List<String> portNames = new ArrayList<>(portIdentifiers.size());

        for(CommPortIdentifier identifier: portIdentifiers){
            portNames.add(identifier.getName());
        }

        return portNames;
    }

    private void writeLogEntryForSerialPort(CommPortIdentifier identifier){
        log.info(
                "Port identifier {} has been detected as a serial port",
                identifier
        );
    }
}