KickJava   Java API By Example, From Geeks To Geeks.

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


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 org.netbeans.api.gsf.annotations.CheckForNull;
23 import org.netbeans.api.gsf.annotations.NonNull;
24 import org.openide.filesystems.FileObject;
25
26 /**
27  * A file passed in to the parser
28  *
29  * @author Tor Norbye
30  */
31 public interface ParserFile {
32
33     /** Return the file object corresponding to the file */
34     @NonNull
35     public FileObject getFileObject();
36
37     /** Return the relative path of the file (relative to its root, such as
38      * a class path root, or a project source root, etc.*/
39     @CheckForNull
40     public String JavaDoc getRelativePath();
41     
42     public String JavaDoc getNameExt();
43     
44     public String JavaDoc getExtension();
45     
46     /**
47      * Return true if this file is part of the "platform" (e.g. Ruby builtins
48      * or gems rather than user source)
49      */
50     public boolean isPlatform();
51 }
52
Popular Tags