001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022/*
023 *    OutputHandler.java
024 */
025package org.biojava.utils.process;
026
027import java.io.InputStream;
028
029/**
030 * Interface to a {@linkplain java.lang.Runnable threadable} output handler for
031 * an {@linkplain org.biojava.utils.process.ExternalProcess external process}. 
032 * The output handler is used to collect the output of the 
033 * {@linkplain java.lang.Process#getOutputStream()() STDOUT} output and/or the
034 * {@linkplain java.lang.Process#getErrorStream() STDERR} of an external
035 * process. 
036 * @author <a href="mailto:Martin.Szugat@GMX.net">Martin Szugat</a>
037 * @version $Revision$
038 */
039public interface OutputHandler extends Runnable {
040
041    /**
042     * Sets the input stream. The output of the external process is written to
043     * this input stream.
044     * @param input the input stream. May be <code>null</code>.
045         */
046        void setInput(InputStream input);
047    
048    /**
049     * Gets the input stream. The output of the external process is written to
050     * this input stream.
051     * @return the input stream. May be <code>null</code>.
052     */
053    /*@pure*/ InputStream getInput();
054}