KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > ristretto > io > Source


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS" basis,
10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11  * for the specific language governing rights and limitations under the
12  * License.
13  *
14  * The Original Code is Ristretto Mail API.
15  *
16  * The Initial Developers of the Original Code are
17  * Timo Stich and Frederik Dietz.
18  * Portions created by the Initial Developers are Copyright (C) 2004
19  * All Rights Reserved.
20  *
21  * Contributor(s):
22  *
23  * Alternatively, the contents of this file may be used under the terms of
24  * either the GNU General Public License Version 2 or later (the "GPL"), or
25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26  * in which case the provisions of the GPL or the LGPL are applicable instead
27  * of those above. If you wish to allow use of your version of this file only
28  * under the terms of either the GPL or the LGPL, and not to allow others to
29  * use your version of this file under the terms of the MPL, indicate your
30  * decision by deleting the provisions above and replace them with the notice
31  * and other provisions required by the GPL or the LGPL. If you do not delete
32  * the provisions above, a recipient may use your version of this file under
33  * the terms of any one of the MPL, the GPL or the LGPL.
34  *
35  * ***** END LICENSE BLOCK ***** */
36 package org.columba.ristretto.io;
37
38 import java.io.IOException JavaDoc;
39
40 /**
41  * Interface definition of Sources.
42  * These are the basic data units that the
43  * parsers of Ristretto work on.
44  *
45  * @author tstich
46  *
47  */
48 public interface Source extends CharSequence JavaDoc {
49     
50     /**
51      * Creates a sub source of this source.
52      *
53      * @param start the start position
54      * @param end the end position
55      * @return the subsource
56      */
57     public Source subSource( int start, int end);
58     
59     /**
60      * Creates a sub source starting from the actual position.
61      *
62      * @return the subsource
63      */
64     public Source fromActualPosition();
65     
66     /**
67      * Get the actual read position of the source.
68      *
69      * @return the actual read position
70      */
71     public int getPosition();
72     
73     /**
74      * Seek to the given position
75      *
76      * @param position
77      * @throws IOException
78      */
79     public void seek(int position) throws IOException JavaDoc;
80     
81     /**
82      * Returns the character at the given position
83      * and increases the position.
84      *
85      * @return the character at the actual position
86      * @throws IOException
87      */
88     public char next() throws IOException JavaDoc;
89     
90     /**
91      * Checks if the end of the Source is reached.
92      *
93      * @return <code>true</code> if the end of the source is reached
94      */
95     public boolean isEOF();
96     
97     /**
98      * Closes the source.
99      *
100      * @throws IOException
101      */
102     public void close() throws IOException JavaDoc;
103     
104     /**
105      * Does a deep close of all sources and subsources
106      * associated with this source.
107      *
108      * @throws IOException
109      */
110     public void deepClose() throws IOException JavaDoc;
111     
112 }
113
Popular Tags