ITypeInfoRequestor


1   /*******************************************************************************
2    * Copyright (c) 2000, 2005 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.jdt.ui.dialogs;
12  
13  /**
14   * An interfaces to give access to the type presented in type
15   * selection dialogs like the open type dialog.
16   * <p>
17   * Please note that <code>ITypeInfoRequestor</code> objects <strong>don't
18   * </strong> have value semantic. The state of the object might change over 
19   * time especially since objects are reused for different call backs. 
20   * </p>
21   * <p>
22   * This interface is not intended to be implemented by clients.
23   * </p>
24   * @since 3.2
25   */
26  public interface ITypeInfoRequestor {
27      
28      /**
29       * Returns the type's modifiers. The modifiers can be 
30       * inspected using the class {@link org.eclipse.jdt.core.Flags}.
31       * 
32       * @return the type's modifiers
33       */
34      public int getModifiers();
35      
36      /**
37       * Returns the type name.
38       * 
39       * @return the info's type name.
40       */
41      public String   getTypeName();
42      
43      /**
44       * Returns the package name.
45       * 
46       * @return the info's package name.
47       */ 
48      public String   getPackageName();
49  
50      /**
51       * Returns a dot separated string of the enclosing types or an 
52       * empty string if the type is a top level type.
53       * 
54       * @return a dot separated string of the enclosing types
55       */
56      public String   getEnclosingName();
57  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags