KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > ui > IFieldData


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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.pde.ui;
12
13 /**
14  * The class that implements this interface is used to provide information
15  * captured in the 'New Plug-in Project' wizard pages as entered by the user.
16  * The information is the provided to other consumers when generating content so
17  * that the content can be configured/customized according to the data.
18  *
19  * @since 2.0
20  */

21 public interface IFieldData {
22     /**
23      * Plug-in identifier field.
24      *
25      * @return plug-in identifier as entered in the wizard
26      */

27     String JavaDoc getId();
28     /**
29      * Plug-in version field.
30      *
31      * @return plug-in version as entered in the wizard
32      */

33     String JavaDoc getVersion();
34     /**
35      * Plug-in name field
36      *
37      * @return plug-in name as entered in the wizard
38      */

39     String JavaDoc getName();
40     /**
41      * Plug-in provider field
42      *
43      * @return plug-in provider as entered in the wizard
44      */

45     String JavaDoc getProvider();
46     /**
47      * Plug-in library field
48      *
49      * @return the name of the initial Java library
50      */

51     String JavaDoc getLibraryName();
52     /**
53      * Source folder field
54      *
55      * @return the name of the Java source folder
56      */

57     String JavaDoc getSourceFolderName();
58     /**
59      * Output folder field
60      *
61      * @return the name of the Java output folder
62      */

63     String JavaDoc getOutputFolderName();
64     /**
65      * Legacy selection
66      *
67      * @return <code>true</code> if the plug-in is created for use with
68      * products based on Eclipse before release 3.0, <code>false</code>
69      * if the plug-in is compatible with Eclipse 3.0.
70      */

71     boolean isLegacy();
72     
73     /**
74      * OSGi bundle selection
75      *
76      * @return <code>true</code> if the plug-in has structure as expected by
77      * OSGi framework in Eclipse 3.0 runtime, <code>false</code> if
78      * the plug-in has standard pre-3.0 layout.
79      */

80     boolean hasBundleStructure();
81     /**
82      * Simple project selection
83      *
84      * @return <code>true</code> if the plug-in should have no Java code and
85      * nature, <code>false</code> otherwise.
86      */

87     boolean isSimple();
88 }
89
Popular Tags