001    /**
002     * Copyright (c) 2012, SIB. All rights reserved.
003     * 
004     * SIB (Swiss Institute of Bioinformatics) - http://www.isb-sib.ch Host -
005     * https://sourceforge.net/projects/javaprotlib/
006     * 
007     * Redistribution and use in source and binary forms, with or without
008     * modification, are permitted provided that the following conditions are met:
009     * Redistributions of source code must retain the above copyright notice, this
010     * list of conditions and the following disclaimer. Redistributions in binary
011     * form must reproduce the above copyright notice, this list of conditions and
012     * the following disclaimer in the documentation and/or other materials provided
013     * with the distribution. Neither the name of the SIB/GENEBIO nor the names of
014     * its contributors may be used to endorse or promote products derived from this
015     * software without specific prior written permission.
016     * 
017     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
020     * ARE DISCLAIMED. IN NO EVENT SHALL SIB/GENEBIO BE LIABLE FOR ANY DIRECT,
021     * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
022     * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
023     * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
024     * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
026     * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027     */
028    package org.expasy.jpl.commons.app;
029    
030    
031    import java.io.IOException;
032    import java.io.InputStream;
033    import java.io.OutputStream;
034    import java.util.regex.Pattern;
035    
036    
037    /**
038     * {@code InteractiveInputScanner} interactively reads input stream.
039     * 
040     * @author nikitin
041     * 
042     * @version 1.0
043     */
044    public interface InteractiveInputScanner {
045            
046            /** Get the command-line prompt */
047            String getPrompt();
048            
049            /** Get the pattern matching the input */
050            Pattern getInputPattern();
051            
052            /** Get the pattern matching the interruption */
053            Pattern getExitPattern();
054            
055            /** Set input stream from where input is find (stdin by default) */
056            void setInputStream(InputStream stream);
057            
058            /** Set output stream to where prompt flushed (stdout by default) */
059            void setOutputStream(OutputStream stream);
060            
061            /** Read input stream */
062            String waitInput() throws IOException;
063            
064            String getDefaultInput();
065    }