View Javadoc

1   /*
2    * $Id: OutputStream.java,v 1.3 2005/10/08 04:05:57 weiju Exp $
3    * 
4    * Created on 05.10.2005
5    * Copyright 2005 by Wei-ju Wu
6    *
7    * This file is part of The Z-machine Preservation Project (ZMPP).
8    *
9    * ZMPP is free software; you can redistribute it and/or modify
10   * it under the terms of the GNU General Public License as published by
11   * the Free Software Foundation; either version 2 of the License, or
12   * (at your option) any later version.
13   *
14   * ZMPP is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Public License for more details.
18   *
19   * You should have received a copy of the GNU General Public License
20   * along with ZMPP; if not, write to the Free Software
21   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22   */
23  package org.zmpp.vm;
24  
25  /***
26   * This interface defines an output stream in the Z-machine.
27   * 
28   * @author Wei-ju Wu
29   * @version 1.0
30   */
31  public interface OutputStream {
32  
33    /***
34     * Prints a Unicode string to the stream.
35     * 
36     * @param str the string to print
37     */
38    void print(String str);
39    
40    /***
41     * Prints a newline.
42     */
43    void newline();
44    
45    /***
46     * Enables/disables this output stream.
47     * 
48     * @param flag true to enable, false to disable
49     */
50    void setEnabled(boolean flag);
51    
52    /***
53     * Determine, if this stream is enabled.
54     * 
55     * @return true if enabled, false if disabled
56     */
57    boolean isEnabled();
58  }