org.netbeans.modules.csl.api.IndexSearcher Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.csl.api;
import java.util.Set;
import javax.swing.Icon;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.annotations.common.NullAllowed;
import org.netbeans.api.project.Project;
import org.netbeans.modules.parsing.spi.indexing.support.QuerySupport;
import org.openide.filesystems.FileObject;
/**
* Helper to locate types for Goto Type, Go To Symbol, etc.
*
* @author Tor Norbye
*/
public interface IndexSearcher {
@NonNull Set getTypes(@NullAllowed Project project, @NonNull String textForQuery,
@NonNull QuerySupport.Kind searchType, @NonNull Helper helper);
@NonNull Set getSymbols(@NullAllowed Project project, @NonNull String textForQuery,
@NonNull QuerySupport.Kind searchType, @NonNull Helper helper);
public abstract class Descriptor {
@NonNull
public abstract ElementHandle getElement();
/**
* Return the simple name of the type (not including qualifiers). The entries
* will typically be sorted by this key.
*
* @return The name of this type, e.g. for java.util.List it would be "List"
*/
public abstract String getSimpleName();
/**
* Return the "outer" name of the type, if any. For Java for example, this would be
* the outer class if this type is an inner class.
* Do not confuse with {@link #getContextName}!
*
* @return The name of the outer class of this type, if any, otherwise return null
*/
public abstract String getOuterName();
/**
* Return the name of this type, along with the outer name. This might
* for example be "Entry in Map" for java.util.Map.Entry
*
* @return The outer and inner name of this type, e.g. for java.util.Map.Entry it would be "Entry in Map"
*/
public abstract String getTypeName();
/**
* Provide additional context for the type name. This would typically be
* the fully qualified name, minus the name part. Return null if there is
* no applicable context. For example, "java.util.List" would return "java.util"
* here.
*
* @return A description of the context of the type, such as the fully qualified name
* minus the name part
*/
public abstract String getContextName();
/**
* Return an icon that should be shown for this type descriptor. The icon
* should give a visual indication of the type of match, e.g. class versus
* module. A default icon will be supplied if this method returns null.
*
* @return An Icon to be shown on the left hand side with the type entry
*/
public abstract Icon getIcon();
/**
* Return the display name of the project containing this type (if any).
*
* @return The display name of the project containing the type declaration
*/
public abstract String getProjectName();
/**
* Return an icon that is applicable for the project defining the type.
* Generally, this should be the same as the project icon. This method will only
* be calld if {@link #getProjectName} returned a non-null value.
*
* @return A project icon corresponding to the project defining this type
*/
public abstract Icon getProjectIcon();
/**
* Return a FileObject for this type.
* This will only be called when the dialog is opening the type or when
* the user selects the file, so it does not have to be as fast as the other
* descriptor attributes.
*
* @return The file object where the type is defined
*/
public abstract FileObject getFileObject();
/**
* Return the document offset corresponding to the type.
* This will only be called when the dialog is opening the type, so
* does not have to be as fast as the other descriptor attributes.
*
* @todo This method is intended to replace the open() call below.
*
* @return The document offset of the type declaration in the declaration file
*/
public abstract int getOffset();
/**
* Open the type declaration in the editor.
* @todo Should we nuke this method and only have type declarations return
* their offsets? I looked at the Java implementation and it's leveraging
* some utility methods to open the type declaration; I have similar methods
* in Ruby. It might be more convenient
*/
public abstract void open();
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof Descriptor)) {
return false;
}
final Descriptor other = (Descriptor) obj;
final FileObject thisFo = getFileObject();
final FileObject otherFo = other.getFileObject();
return thisFo == null ?
otherFo == null :
thisFo.equals(otherFo);
}
@Override
public int hashCode() {
final FileObject fo = getFileObject();
return fo == null ?
0 :
fo.hashCode();
}
}
public interface Helper {
@CheckForNull Icon getIcon(@NonNull ElementHandle element);
void open(@NonNull FileObject fileObject, @NonNull ElementHandle element);
}
}