001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.gsfret.source.usages;
043:
044: import java.io.File;
045: import java.io.IOException;
046: import java.net.URL;
047: import java.util.Map;
048: import java.util.Set;
049: import org.netbeans.modules.gsf.api.Index.SearchResult;
050: import org.netbeans.modules.gsf.api.NameKind;
051: import org.netbeans.napi.gsfret.source.ClassIndex;
052: import org.netbeans.napi.gsfret.source.Source;
053: import org.openide.filesystems.FileObject;
054:
055: /**
056: * This file is originally from Retouche, the Java Support
057: * infrastructure in NetBeans. I have modified the file as little
058: * as possible to make merging Retouche fixes back as simple as
059: * possible.
060: *
061: * Should probably final class with private constructor.
062: *
063: * @author Petr Hrebejk, Tomas Zezula
064: */
065: public abstract class ClassIndexImpl {
066:
067: public static enum UsageType {
068:
069: SUPER_CLASS(0), SUPER_INTERFACE(1), FIELD_REFERENCE(2), METHOD_REFERENCE(
070: 3), TYPE_REFERENCE(4);
071:
072: private int offset;
073:
074: UsageType(final int offset) {
075: this .offset = offset;
076: }
077:
078: int getOffset() {
079: return this .offset;
080: }
081: }
082:
083: public static ClassIndexFactory FACTORY;
084:
085: public abstract FileObject[] getSourceRoots();
086:
087: // public abstract BinaryAnalyser getBinaryAnalyser ();
088:
089: public abstract SourceAnalyser getSourceAnalyser();
090:
091: public abstract void setDirty(Source js);
092:
093: protected abstract void close() throws IOException;
094:
095: // BEGIN TOR MODIFICATIONS
096: //public abstract void gsfStore(Set<Map<String,String>> fieldToData, Set<String> toDelete) throws IOException;
097: // For index browser
098: public abstract void search(final String primaryField,
099: final String name, final NameKind kind,
100: final Set<ClassIndex.SearchScope> scope, /*final ResultConvertor<T> convertor,*/
101: final Set<SearchResult> result, Set<String> terms)
102: throws IOException;
103:
104: public abstract URL getRoot();
105:
106: public abstract File getSegment();
107:
108: public abstract Map<String, String> getTimeStamps()
109: throws IOException;
110:
111: public abstract void storeEmpty();
112: // END TOR MODIFICATIONS
113:
114: }
|