1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: IInputImp.java,v 1.4 2005/09/10 11:26:47 mat007 Exp $
29 */
30
31 package jtge.engine.io;
32
33 import jtge.engine.command.ICommand;
34
35 /***
36 * Defines an input implementation.
37 * <p>
38 * This interface acts as the implementor in the bridge pattern.
39 * <p>
40 * Implementation classes must be thread-safe.
41 *
42 * @see Input
43 * @author Mathieu Champlon
44 * @version $Revision: 1.4 $ $Date: 2005/09/10 11:26:47 $
45 */
46 public interface IInputImp
47 {
48 /***
49 * Read one command.
50 * <p>
51 * This method should block until the reading is done. <br>
52 * The input must be closed when the method returns null.
53 *
54 * @return read command or null if the input is closed
55 */
56 ICommand read();
57
58 /***
59 * Close the input if needed.
60 */
61 void close();
62
63 /***
64 * Check whether the input is closed or not.
65 *
66 * @return current close status.
67 */
68 boolean isClosed();
69 }