RandomAccessStream


1   /*
2    * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3    *
4    * This file is part of Resin(R) Open Source
5    *
6    * Each copy or derived work must preserve the copyright notice and this
7    * notice unmodified.
8    *
9    * Resin Open Source 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   * Resin Open Source 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, or any warranty
17   * of NON-INFRINGEMENT.  See the GNU General Public License for more
18   * details.
19   *
20   * You should have received a copy of the GNU General Public License
21   * along with Resin Open Source; if not, write to the
22   *
23   *   Free Software Foundation, Inc.
24   *   59 Temple Place, Suite 330
25   *   Boston, MA 02111-1307  USA
26   *
27   * @author Scott Ferguson
28   */
29  
30  package com.caucho.vfs;
31  
32  import java.io.IOException  ;
33  import java.io.InputStream  ;
34  import java.io.OutputStream  ;
35  
36  /**
37   * Reads from a file in a random-access fashion.
38   */
39  abstract public class RandomAccessStream {
40    /**
41     * Returns the length.
42     */
43    abstract public long getLength()
44      throws IOException  ;
45    
46    /**
47     * Reads a block starting from the current file pointer.
48     */
49    abstract public int read(byte []buffer, int offset, int length)
50      throws IOException  ;
51  
52    /**
53     * Reads a block from a given location.
54     */
55    abstract public int read(long fileOffset,
56                 byte []buffer, int offset, int length)
57      throws IOException  ;
58  
59    /**
60     * Writes a block starting from the current file pointer.
61     */
62    abstract public void write(byte []buffer, int offset, int length)
63      throws IOException  ;
64  
65    /**
66     * Writes a block to a given location.
67     */
68    abstract public void write(long fileOffset,
69                   byte []buffer, int offset, int length)
70      throws IOException  ;
71  
72    /**
73     * Seeks to the given position in the file.
74     */
75    abstract public boolean seek(long position);
76  
77    /**
78     * Returns an OutputStream for this stream.
79     */
80    abstract public OutputStream   getOutputStream()
81      throws IOException  ;
82  
83    /**
84     * Returns an InputStream for this stream.
85     */
86    abstract public InputStream   getInputStream()
87      throws IOException  ;
88  
89    /**
90     * Read a byte from the file, advancing the pointer.
91     */
92    abstract public int read()
93      throws IOException  ;
94  
95    /**
96     * Write a byte to the file, advancing the pointer.
97     */
98    abstract public void write(int b)
99      throws IOException  ;
100 
101   /**
102    * Returns the current position of the file pointer.
103    */
104   abstract public long getFilePointer()
105     throws IOException  ;
106 
107   /**
108    * Closes the stream.
109    */
110   public void close() throws IOException  
111   {
112   }
113 }
114
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags