KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.io.UnsupportedEncodingException JavaDoc;
57
58 /******************************************************************************
59  * A ByteBuffer that accepts characters and Strings as well.
60  *
61  * @author Brian S O'Neill
62  * @version
63  * <!--$$Revision:--> 14 <!-- $-->, <!--$$JustDate:--> 01/04/18 <!-- $-->
64  */
65 public interface CharToByteBuffer extends ByteBuffer {
66     /**
67      * Set the encoding for converting characters to bytes. Calling getEncoding
68      * will return the canonical encoding name and may differ from the
69      * encoding name provided to this method.
70      */
71     public void setEncoding(String JavaDoc enc)
72         throws IOException JavaDoc, UnsupportedEncodingException JavaDoc;
73
74     /**
75      * Returns the current encoding that is being used to convert characters
76      * to bytes or null if no encoding has been set yet. The encoding name
77      * that is returned is canonical and may differ from the name passed into
78      * setEncoding.
79      */
80     public String JavaDoc getEncoding() throws IOException JavaDoc;
81
82     /**
83      * Add one character to the end of this buffer.
84      */
85     public void append(char c) throws IOException JavaDoc;
86
87     /**
88      * Copy the given characters to the end of this buffer.
89      */
90     public void append(char[] chars) throws IOException JavaDoc;
91
92     /**
93      * Copy the given characters to the end of this buffer, starting at the
94      * offset, using the length provided.
95      */
96     public void append(char[] chars, int offset, int length)
97         throws IOException JavaDoc;
98
99     /**
100      * Copy the given String to the end of this buffer.
101      */
102     public void append(String JavaDoc str) throws IOException JavaDoc;
103
104     /**
105      * Copy the given String to the end of this buffer, starting at the offset,
106      * using the length provided.
107      */
108     public void append(String JavaDoc str, int offset, int length) throws IOException JavaDoc;
109
110     /**
111      * Force any buffered characters to be immediately converted to bytes.
112      */
113     public void drain() throws IOException JavaDoc;
114 }
115
Popular Tags