KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > batik > util > io > CharDecoder


1 /*
2
3    Copyright 2002 The Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16
17  */
18 package org.apache.batik.util.io;
19
20 import java.io.IOException JavaDoc;
21
22 /**
23  * This interface represents an object which decodes characters from a
24  * stream of bytes.
25  *
26  * @author <a HREF="mailto:stephane@hillion.org">Stephane Hillion</a>
27  * @version $Id: CharDecoder.java,v 1.3 2004/08/18 07:15:58 vhardy Exp $
28  */
29 public interface CharDecoder {
30     
31     /**
32      * This constant represents the end of stream character.
33      */
34     int END_OF_STREAM = -1;
35
36     /**
37      * Reads the next character.
38      * @return a character or END_OF_STREAM.
39      */
40     int readChar() throws IOException JavaDoc;
41
42     /**
43      * Disposes the associated resources.
44      */
45     void dispose() throws IOException JavaDoc;
46 }
47
Popular Tags