/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.netbeans.spi.jumpto.type;
import javax.swing.Icon;
import org.openide.filesystems.FileObject;
/**
* A TypeDescriptor describes a type for display in the Go To Type dialog.
* Items should be comparable such that the infrastructure can return these.
*
* @author Tor Norbye
*/
public abstract class TypeDescriptor {
/**
* 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();
/**
* <p>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.</p>
* <p>Do not confuse with {@link #getContextName}!</p>
*
* @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();
}
|