KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > retouche > source > usages > ClassIndexImpl


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.modules.retouche.source.usages;
21
22 import java.io.File JavaDoc;
23 import java.io.IOException JavaDoc;
24 import java.net.URL JavaDoc;
25 import java.util.Map JavaDoc;
26 import java.util.Set JavaDoc;
27 import org.netbeans.api.gsf.Index.SearchResult;
28 import org.netbeans.api.retouche.source.ClassIndex;
29 import org.netbeans.api.retouche.source.Source;
30 import org.openide.filesystems.FileObject;
31
32 /**
33  * This file is originally from Retouche, the Java Support
34  * infrastructure in NetBeans. I have modified the file as little
35  * as possible to make merging Retouche fixes back as simple as
36  * possible.
37  *
38  * Should probably final class with private constructor.
39  *
40  * @author Petr Hrebejk, Tomas Zezula
41  */
42 public abstract class ClassIndexImpl {
43
44
45     public static enum UsageType {
46
47         SUPER_CLASS( 0 ),
48         SUPER_INTERFACE( 1 ),
49         FIELD_REFERENCE( 2 ),
50         METHOD_REFERENCE( 3 ),
51         TYPE_REFERENCE (4);
52
53         private int offset;
54
55         UsageType( final int offset) {
56             this.offset = offset;
57         }
58
59         int getOffset () {
60             return this.offset;
61         }
62     }
63     
64     
65     public static ClassIndexFactory FACTORY;
66     
67     public abstract FileObject[] getSourceRoots ();
68    
69     public abstract BinaryAnalyser getBinaryAnalyser ();
70     
71     public abstract SourceAnalyser getSourceAnalyser ();
72     
73     public abstract void setDirty (Source js);
74     
75     protected abstract void close () throws IOException JavaDoc;
76     
77     // BEGIN TOR MODIFICATIONS
78 //public abstract void gsfStore(Set<Map<String,String>> fieldToData, Set<String> toDelete) throws IOException;
79 public abstract void gsfSearch(final String JavaDoc primaryField, final String JavaDoc name, final ClassIndex.NameKind kind,
80             final Set JavaDoc<ClassIndex.SearchScope> scope, /*final ResultConvertor<T> convertor,*/
81             final Set JavaDoc<SearchResult> result) throws IOException JavaDoc;
82     public abstract URL JavaDoc getRoot();
83     public abstract File JavaDoc getSegment();
84     // END TOR MODIFICATIONS
85
86 }
87
Popular Tags