View Javadoc

1   /*
2    * Copyright (c) 2003 Peter Antman, Teknik i Media  <peter.antman@tim.se>
3    *
4    * $Id: CachedInputStream.java,v 1.1.1.1 2004/05/19 12:07:30 pra Exp $
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2 of the License, or (at your option) any later version
10   * 
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   * 
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package org.backsource.utils.io;
21  import java.io.InputStream;
22  import java.io.BufferedInputStream;
23  import java.io.IOException;
24  /***
25   * This is an InputStream that reads from cached data it will get
26   * from a CachedOutputStream.
27   *
28   * <p>The stream is therefore possible to reuse, after rewind has
29    been invoked.</p>
30   * <p>To be able to use these cinds of input stream with external API:s, such as the apache JAXP imlementation, the close method does nothing. To really close the stream use {@link #close(boolean)}.</p>
31   *
32   * @author <a href="mailto:pra@tim.se">Peter Antman</a>
33   * @version $Revision: 1.1.1.1 $
34   */
35  
36  public abstract class CachedInputStream extends BufferedInputStream {
37     public CachedInputStream(InputStream is) {
38        super(is);
39     }
40  
41     /***
42      * Does not close stream, to close an CachedInputStream use close(true).
43      */
44     public void close() throws IOException {
45        close(false);
46     }
47  
48     /***
49      * Close the input stream if argument is true.
50      */
51     public void close(boolean reallyClose) throws IOException {
52        if ( reallyClose) {
53           super.close();
54        } // end of if ()
55        
56     }
57  
58     /***
59      * rewind the cached input stream so that next read starts from the beginning.
60      */
61     public abstract void rewind() throws IOException;
62     
63  }// CachedInputStream