KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > gsf > SourceFileReader


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.gsf;
21
22 import java.io.IOException JavaDoc;
23 import org.openide.filesystems.FileObject;
24
25 /**
26  * Implementations of this interface can read the contents of a FileObject.
27  * The IDE can for example provide a reader which either fetches the contents
28  * from disk, or from an open editor buffer if it has been edited.
29  *
30  * @author Tor Norbye
31  */
32 public interface SourceFileReader {
33     /**
34      * Return a character sequence for the contents of the given file,
35      * which could be on disk, or modified in an open document, etc.
36      */
37     CharSequence JavaDoc read(ParserFile file) throws IOException JavaDoc;
38     
39     /**
40      * Return the last known caret offset of the given file, if it is being edited.
41      * Return -1 if the file is not open, or if the caret offset is not currently
42      * known.
43      */
44     int getCaretOffset(ParserFile file);
45 }
46
Popular Tags