KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > imagero > uio > buffer > BufferManager


1 /*
2  * Copyright (c) Andrey Kuznetsov. All Rights Reserved.
3  *
4  * http://uio.imagero.com
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * o Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * o Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * o Neither the name of imagero Andrei Kouznetsov nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 package com.imagero.uio.buffer;
33
34 import java.io.IOException JavaDoc;
35
36 /**
37  * BufferManager.java
38  *
39  * @author Andrei Kouznetsov
40  */
41 public interface BufferManager {
42
43     final byte[] empty = new byte[0];
44
45     /**
46      * Get data (as byte array) from i'th Buffer
47      *
48      * @param i Buffer index
49      *
50      * @return byte array
51      */
52     byte[] getData(int i) throws IOException JavaDoc;
53
54     /**
55      * Get count of Buffer objects in this BufferManager
56      *
57      * @return int
58      */
59     int getCount();
60
61     /**
62      * Get length of i'th Buffer
63      *
64      * @param i Buffer index
65      *
66      * @return int
67      */
68     int getDataLength(int i);
69
70     /**
71      * Get index of Buffer which contains <code>pos</code>
72      *
73      * @param pos
74      *
75      */
76     int getIndex(long pos);
77
78     /**
79      * Get length of data of all Buffer together
80      *
81      */
82     long getLength();
83
84     /**
85      * Allows to free all possibly used resources
86      */
87     void close();
88
89     /**
90      * get start of i'th Buffer in byte<br>
91      *
92      * @param i Buffer index
93      *
94      * @return int
95      * <TABLE ALIGN="left" BORDER=0 CELLSPACING=0 CELLPADDING=0>
96      * <TR ALIGN="left" VALIGN="middle">
97      * <TD valign="middle" colspan="3">
98      * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<FONT SIZE="1">n-1</FONT><br>
99      * </TD>
100      * </tr>
101      * <TR ALIGN="left" VALIGN="middle">
102      * <TD valign="middle">
103      * dataStart(n) =
104      * </TD>
105      * <TD valign="middle">
106      * <FONT SIZE="7">&#x03A3;</FONT>
107      * </TD>
108      * <TD valign="middle">
109      * getDataLength(i)
110      * </TD>
111      * </tr>
112      * <TR ALIGN="left" VALIGN="middle">
113      * <TD valign="middle" colspan="3">
114      * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<FONT SIZE="1">i=0</FONT><br>
115      * </TD>
116      * </tr>
117      * </TABLE>
118      */
119     long getDataStart(int i);
120
121     /**
122      * clear all buffered data without closing
123      */
124     void clear();
125
126     /**
127      * get max buffer count
128      * @return max buffer count
129      */
130     int getMaxCache();
131
132     /**
133      * set max buffer count
134      */
135     void setMaxCache(int max);
136
137     /**
138      * all buffered data in stream between start and end will be cleared
139      */
140     void clear(long start, long end) throws IOException JavaDoc;
141 }
142
Popular Tags