KickJava   Java API By Example, From Geeks To Geeks.

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


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.openide.filesystems.FileObject;
23
24 /**
25  * Based on org.netbeans.api.java.source by Tomas Zezula
26  *
27  * @author Tor Norbye
28  */
29 public abstract class ElementHandle<T extends Element> {
30     /**
31      * Return the FileObject associated with this handle, or null
32      * if the file is unknown or in a parse tree (in which case the
33      * file object is the same as the file object in the CompilationInfo
34      * for the root of the parse tree.
35      */
36     public abstract FileObject getFileObject();
37     
38     /**
39      * Tests if the handle has the same signature as the parameter.
40      * The handles with the same signatures are resolved into the same
41      * element in the same {@link javax.tools.JavaCompiler} task, but may be resolved into
42      * the different {@link Element}s in the different {@link javax.tools.JavaCompiler} tasks.
43      * @param handle to be checked
44      * @return true if the handles resolve into the same {@link Element}s
45      * in the same {@link javax.tools.JavaCompiler} task.
46      */
47     public abstract boolean signatureEquals (final ElementHandle<? extends Element> handle);
48     
49 }
50
Popular Tags