package jmri.jmrix.ecos;

import java.util.Vector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Test scaffold implementation of EcosInterface.
 * Use an object of this type as a EcosTrafficController in tests.
 *
 * @author Bob Jacobsen Copyright (C) 2002, 2006
 */
public class EcosInterfaceScaffold extends EcosTrafficController {

    public EcosInterfaceScaffold() {
    }

    // override some EcosTrafficController methods for test purposes
    @Override
    public boolean status() {
        return true;
    }

    /**
     * record Ecos messages sent, provide access for making sure they are OK
     */
    public Vector<EcosMessage> outbound = new Vector<EcosMessage>();  // public OK here, so long as this is a test class

    @Override
    public void sendEcosMessage(EcosMessage m, EcosListener replyTo) {
        log.debug("sendEcosMessage [{}]", m);
        // save a copy
        outbound.addElement(m);
    }

    // test control member functions
    /**
     * Forward a message to the listeners, e.g. test receipt.
     */
    public void sendTestMessage(EcosReply m) {
        // forward a test message to EcosListeners
        log.debug("sendTestMessage    [{}]", m);
        notifyReply(m, null);
    }

    /*
     * Check number of listeners, used for testing dispose()
     */
    public int numListeners() {
        return cmdListeners.size();
    }

    /**
     * Avoid error message, normal in parent.
     */
    @Override
    protected void connectionWarn() {
    }

    /**
     * Avoid error message, normal in parent.
     */
    @Override
    protected void portWarn(Exception e) {
    }

    @Override
    public void receiveLoop() {
    }

    private static final Logger log = LoggerFactory.getLogger(EcosInterfaceScaffold.class);

}