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.spi.jumpto.type;
043:
044: import javax.swing.Icon;
045: import org.openide.filesystems.FileObject;
046:
047: /**
048: * A TypeDescriptor describes a type for display in the Go To Type dialog.
049: * Items should be comparable such that the infrastructure can return these.
050: *
051: * @author Tor Norbye
052: */
053: public abstract class TypeDescriptor {
054: /**
055: * Return the simple name of the type (not including qualifiers). The entries
056: * will typically be sorted by this key.
057: *
058: * @return The name of this type, e.g. for java.util.List it would be "List"
059: */
060: public abstract String getSimpleName();
061:
062: /**
063: * <p>Return the "outer" name of the type, if any. For Java for example, this would be
064: * the outer class if this type is an inner class.</p>
065: * <p>Do not confuse with {@link #getContextName}!</p>
066: *
067: * @return The name of the outer class of this type, if any, otherwise return null
068: */
069: public abstract String getOuterName();
070:
071: /**
072: * Return the name of this type, along with the outer name. This might
073: * for example be "Entry in Map" for java.util.Map.Entry
074: *
075: * @return The outer and inner name of this type, e.g. for java.util.Map.Entry it would be "Entry in Map"
076: */
077: public abstract String getTypeName();
078:
079: /**
080: * Provide additional context for the type name. This would typically be
081: * the fully qualified name, minus the name part. Return null if there is
082: * no applicable context. For example, "java.util.List" would return "java.util"
083: * here.
084: *
085: * @return A description of the context of the type, such as the fully qualified name
086: * minus the name part
087: */
088: public abstract String getContextName();
089:
090: /**
091: * Return an icon that should be shown for this type descriptor. The icon
092: * should give a visual indication of the type of match, e.g. class versus
093: * module. A default icon will be supplied if this method returns null.
094: *
095: * @return An Icon to be shown on the left hand side with the type entry
096: */
097: public abstract Icon getIcon();
098:
099: /**
100: * Return the display name of the project containing this type (if any).
101: *
102: * @return The display name of the project containing the type declaration
103: */
104: public abstract String getProjectName();
105:
106: /**
107: * Return an icon that is applicable for the project defining the type.
108: * Generally, this should be the same as the project icon. This method will only
109: * be calld if {@link #getProjectName} returned a non-null value.
110: *
111: * @return A project icon corresponding to the project defining this type
112: */
113: public abstract Icon getProjectIcon();
114:
115: /**
116: * Return a FileObject for this type.
117: * This will only be called when the dialog is opening the type or when
118: * the user selects the file, so it does not have to be as fast as the other
119: * descriptor attributes.
120: *
121: * @return The file object where the type is defined
122: */
123: public abstract FileObject getFileObject();
124:
125: /**
126: * Return the document offset corresponding to the type.
127: * This will only be called when the dialog is opening the type, so
128: * does not have to be as fast as the other descriptor attributes.
129: *
130: * @todo This method is intended to replace the open() call below.
131: *
132: * @return The document offset of the type declaration in the declaration file
133: */
134: public abstract int getOffset();
135:
136: /**
137: * Open the type declaration in the editor.
138: * @todo Should we nuke this method and only have type declarations return
139: * their offsets? I looked at the Java implementation and it's leveraging
140: * some utility methods to open the type declaration; I have similar methods
141: * in Ruby. It might be more convenient
142: */
143: public abstract void open();
144: }
|