KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > trove > io > ByteBuffer


1 /* ====================================================================
2  * Trove - Copyright (c) 1999-2000 Walt Disney Internet Group
3  * ====================================================================
4  * The Tea Software License, Version 1.1
5  *
6  * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Walt Disney Internet Group (http://opensource.go.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact opensource@dig.com.
31  *
32  * 5. Products derived from this software may not be called "Tea",
33  * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
34  * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
35  * written permission of the Walt Disney Internet Group.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
41  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
42  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
43  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
44  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
45  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * For more information about Tea, please see http://opensource.go.com/.
51  */
52
53 package com.go.trove.io;
54
55 import java.io.IOException JavaDoc;
56
57 /******************************************************************************
58  * ByteBuffer extends ByteData such that bytes can be added to it.
59  *
60  * @author Brian S O'Neill
61  * @version
62  * <!--$$Revision:--> 13 <!-- $-->, <!--$$JustDate:--> 00/12/05 <!-- $-->
63  */
64 public interface ByteBuffer extends ByteData {
65     /**
66      * Returns the base byte count, which excludes surrogates.
67      */
68     public long getBaseByteCount() throws IOException JavaDoc;
69
70     /**
71      * Add one byte to the end of this buffer.
72      */
73     public void append(byte b) throws IOException JavaDoc;
74
75     /**
76      * Copy the given bytes to the end of this buffer.
77      */
78     public void append(byte[] bytes) throws IOException JavaDoc;
79
80     /**
81      * Copy the given bytes to the end of this buffer, starting at the offset,
82      * using the length provided.
83      */
84     public void append(byte[] bytes, int offset, int length)
85         throws IOException JavaDoc;
86
87     /**
88      * Append ByteData that will not be touched until this ByteBuffer needs
89      * to calculate its byte count, or it needs to write out. A null surrogate
90      * is not appended.
91      */
92     public void appendSurrogate(ByteData s) throws IOException JavaDoc;
93
94     /**
95      * Add a ByteBuffer that will receive a copy of all the data appended to
96      * this ByteBuffer.
97      */
98     public void addCaptureBuffer(ByteBuffer buffer) throws IOException JavaDoc;
99
100     /**
101      * Remove a capture buffer that was previously added by addCaptureBuffer.
102      */
103     public void removeCaptureBuffer(ByteBuffer buffer) throws IOException JavaDoc;
104 }
105
Popular Tags