← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to utilities/jumpto/src/org/netbeans/spi/jumpto/type/TypeDescriptor.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
utilities/jumpto/src/org/netbeans/spi/jumpto/type/TypeDescriptor.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.spi.jumpto.type;
 
43
 
 
44
import javax.swing.Icon;
 
45
import org.openide.filesystems.FileObject;
 
46
 
 
47
/**
 
48
 * A TypeDescriptor describes a type for display in the Go To Type dialog.
 
49
 * Items should be comparable such that the infrastructure can return these.
 
50
 * 
 
51
 * @author Tor Norbye
 
52
 */
 
53
public abstract class TypeDescriptor {
 
54
    /**
 
55
     * Return the simple name of the type (not including qualifiers). The entries
 
56
     * will typically be sorted by this key.
 
57
     * 
 
58
     * @return The name of this type, e.g. for java.util.List it would be "List"
 
59
     */
 
60
    public abstract String getSimpleName();
 
61
 
 
62
    /**
 
63
     * <p>Return the "outer" name of the type, if any. For Java for example, this would be
 
64
     * the outer class if this type is an inner class.</p>
 
65
     * <p>Do not confuse with {@link #getContextName}!</p> 
 
66
     * 
 
67
     * @return The name of the outer class of this type, if any, otherwise return null
 
68
     */
 
69
    public abstract String getOuterName();
 
70
 
 
71
    /**
 
72
     * Return the name of this type, along with the outer name. This might
 
73
     * for example be "Entry in Map" for java.util.Map.Entry
 
74
     * 
 
75
     * @return The outer and inner name of this type, e.g. for java.util.Map.Entry it would be "Entry in Map"
 
76
     */
 
77
    public abstract String getTypeName();
 
78
     
 
79
    /**
 
80
     * Provide additional context for the type name. This would typically be
 
81
     * the fully qualified name, minus the name part. Return null if there is
 
82
     * no applicable context. For example, "java.util.List" would return "java.util"
 
83
     * here.
 
84
     * 
 
85
     * @return A description of the context of the type, such as the fully qualified name
 
86
     *   minus the name part
 
87
     */
 
88
    public abstract String getContextName();
 
89
 
 
90
    /** 
 
91
     * Return an icon that should be shown for this type descriptor. The icon
 
92
     * should give a visual indication of the type of match, e.g. class versus
 
93
     * module.  A default icon will be supplied if this method returns null.
 
94
     * 
 
95
     * @return An Icon to be shown on the left hand side with the type entry
 
96
     */
 
97
     public abstract Icon getIcon();
 
98
     
 
99
    /**
 
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
}