IExternalToolConstants


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.ui.externaltools.internal.model;
12  
13  /**
14   * Defines the constants available for client use.
15   * <p>
16   * This interface is not intended to be extended or implemented by clients.
17   * </p>
18   */
19  public interface IExternalToolConstants {
20      /**
21       * Plugin identifier for external tools (value <code>org.eclipse.ui.externaltools</code>).
22       */
23      public static final String   PLUGIN_ID = "org.eclipse.ui.externaltools"; //$NON-NLS-1$;
24  
25      // ------- Extensions Points -------
26      /**
27       * Extension point to declare the launch configuration type that should be
28       * created when duplicating an existing configuration as a project builder.
29       */
30      public static final String   EXTENSION_POINT_CONFIGURATION_DUPLICATION_MAPS = "configurationDuplicationMaps"; //$NON-NLS-1$
31      // ------- Refresh Variables -------
32      /**
33       * Variable that expands to the workspace root object (value <code>workspace</code>).
34       */
35      public static final String   VAR_WORKSPACE = "workspace"; //$NON-NLS-1$
36      /**
37       * Variable that expands to the project resource (value <code>project</code>).
38       */
39      public static final String   VAR_PROJECT = "project"; //$NON-NLS-1$
40      /**
41       * Variable that expands to the container resource (value <code>container</code>).
42       */
43      public static final String   VAR_CONTAINER = "container"; //$NON-NLS-1$
44      /**
45       * Variable that expands to a resource (value <code>resource</code>).
46       */
47      public static final String   VAR_RESOURCE = "resource"; //$NON-NLS-1$
48      /**
49       * Variable that expands to the working set object (value <code>working_set</code>).
50       */
51      public static final String   VAR_WORKING_SET = "working_set"; //$NON-NLS-1$
52      // ------- Tool Types -------
53      /**
54       * External tool type for programs such as executables, batch files, 
55       * shell scripts, etc (value <code>programType</code>).
56       */
57      public static final String   TOOL_TYPE_PROGRAM = "programType"; //$NON-NLS-1$;
58  
59      // ------- Build Types -------
60      /**
61       * Build type indicating an incremental project build request for
62       * the external tool running as a builder (value <code>incremental</code>).
63       */
64      public static final String   BUILD_TYPE_INCREMENTAL = "incremental"; //$NON-NLS-1$
65  
66      /**
67       * Build type indicating a full project build request for
68       * the external tool running as a builder (value <code>full</code>).
69       */
70      public static final String   BUILD_TYPE_FULL = "full"; //$NON-NLS-1$
71  
72      /**
73       * Build type indicating an automatic project build request for
74       * the external tool running as a builder (value <code>auto</code>).
75       */
76      public static final String   BUILD_TYPE_AUTO = "auto"; //$NON-NLS-1$
77      
78      /**
79       * Build type indicating a clean project build request for
80       * the external tool running as a builder (value <code>clean</code>).
81       */
82      public static final String   BUILD_TYPE_CLEAN = "clean"; //$NON-NLS-1$
83  
84      /**
85       * Build type indicating no project build request for
86       * the external tool running as a builder (value <code>none</code>).
87       */
88      public static final String   BUILD_TYPE_NONE = "none"; //$NON-NLS-1$
89  
90      // ------- Images -------
91  
92      /**
93       * Main tab image.
94       */
95      public static final String   IMG_TAB_MAIN = PLUGIN_ID + ".IMG_TAB_MAIN"; //$NON-NLS-1$
96      
97      // ------- Launch configuration types --------
98      /**
99       * Program launch configuration type identifier.
100      */
101     public static final String   ID_PROGRAM_LAUNCH_CONFIGURATION_TYPE = "org.eclipse.ui.externaltools.ProgramLaunchConfigurationType"; //$NON-NLS-1$
102     
103     /**
104      * Program builder launch configuration type identifier. Program project
105      * builders are of this type.
106      */
107     public static final String   ID_PROGRAM_BUILDER_LAUNCH_CONFIGURATION_TYPE = "org.eclipse.ui.externaltools.ProgramBuilderLaunchConfigurationType"; //$NON-NLS-1$   
108     
109     // ------- Launch configuration category --------
110     /**
111      * Identifier for external tools launch configuration category. Launch
112      * configuration types for external tools that appear in the external tools
113      * launch configuration dialog should belong to this category.
114      */
115     public static final String   ID_EXTERNAL_TOOLS_LAUNCH_CATEGORY = "org.eclipse.ui.externaltools"; //$NON-NLS-1$
116     /**
117      * Identifier for external tools launch configuration builders category.
118      * Launch configuration types that can be added as project builders should
119      * belong to this category.
120      */
121     public static final String   ID_EXTERNAL_TOOLS_BUILDER_LAUNCH_CATEGORY = "org.eclipse.ui.externaltools.builder"; //$NON-NLS-1$
122 
123     // ------- Launch configuration groups --------
124     /**
125      * Identifier for external tools launch configuration group. The external
126      * tools launch configuration group corresponds to the external tools
127      * category in run mode.
128      */
129     public static final String   ID_EXTERNAL_TOOLS_LAUNCH_GROUP = "org.eclipse.ui.externaltools.launchGroup"; //$NON-NLS-1$
130     /**
131      * Identifier for external tools launch configuration group
132      */
133     public static final String   ID_EXTERNAL_TOOLS_BUILDER_LAUNCH_GROUP = "org.eclipse.ui.externaltools.launchGroup.builder"; //$NON-NLS-1$
134 
135     // ------- Common External Tool Launch Configuration Attributes -------
136 
137     /**
138      * Boolean attribute indicating if external tool output should be captured.
139      * Default value is <code>false</code>.
140      * @deprecated since 3.1 Replaced by <code>org.eclipse.debug.core.DebugPlugin.ATTR_CAPTURE_OUTPUT</code>
141      */
142     public static final String   ATTR_CAPTURE_OUTPUT = PLUGIN_ID + ".ATTR_CAPTURE_OUTPUT"; //$NON-NLS-1$
143     /**
144      * String attribute identifying the location of an external. Default value
145      * is <code>null</code>. Encoding is tool specific.
146      */
147     public static final String   ATTR_LOCATION = PLUGIN_ID + ".ATTR_LOCATION"; //$NON-NLS-1$
148 
149     /**
150      * Boolean attribute indicating if the user should be prompted for
151      * arguments before running a tool. Default value is <code>false</code>.
152      * THIS ATTRIBUTE IS NOT USED.
153      */
154     public static final String   ATTR_PROMPT_FOR_ARGUMENTS = PLUGIN_ID + ".ATTR_PROMPT_FOR_ARGUMENTS"; //$NON-NLS-1$
155     
156     /**
157      * String attribute identifying the scope of resources that should trigger an 
158      * external tool to run. Default value is <code>null</code>
159      * indicating that the builder will be triggered for all changes.
160      */
161     public static final String   ATTR_BUILD_SCOPE = PLUGIN_ID + ".ATTR_BUILD_SCOPE"; //$NON-NLS-1$
162         
163     
164     /**
165      * String attribute containing an array of build kinds for which an
166      * external tool builder should be run.
167      */
168     public static final String   ATTR_RUN_BUILD_KINDS = PLUGIN_ID + ".ATTR_RUN_BUILD_KINDS"; //$NON-NLS-1$
169     
170     /**
171      * Boolean attribute indicating if the console should be shown on external
172      * tool output. Default value is <code>false</code>.
173      */
174     public static final String   ATTR_SHOW_CONSOLE = PLUGIN_ID + ".ATTR_SHOW_CONSOLE"; //$NON-NLS-1$
175 
176     /**
177      * String attribute containing the arguments that should be passed to the
178      * tool. Default value is <code>null</code>, and encoding is tool specific.
179      */
180     public static final String   ATTR_TOOL_ARGUMENTS = PLUGIN_ID + ".ATTR_TOOL_ARGUMENTS"; //$NON-NLS-1$
181 
182     /**
183      * String attribute identifying the working directory of an external tool.
184      * Default value is <code>null</code>, which indicates a default working
185      * directory, which is tool specific.
186      */
187     public static final String   ATTR_WORKING_DIRECTORY = PLUGIN_ID + ".ATTR_WORKING_DIRECTORY"; //$NON-NLS-1$
188     
189     /**
190      * String attribute identifying whether an external tool builder configuration
191      * is enabled. The default value is <code>true</code>, which indicates
192      * that the configuration will be executed as appropriate by the builder.
193      */
194     public static final String   ATTR_BUILDER_ENABLED = PLUGIN_ID + ".ATTR_BUILDER_ENABLED"; //$NON-NLS-1$
195     
196     /**
197      * Status code indicating an unexpected internal error.
198      */
199     public static final int ERR_INTERNAL_ERROR = 150;
200 
201     /**
202      * String attribute identifying a non-external tool builder launch configuration that is disabled
203      * The value is the name of the disabled builder.
204      */
205     public static final String   ATTR_DISABLED_BUILDER = PLUGIN_ID + ".ATTR_DISABLED_BUILDER";         //$NON-NLS-1$
206     
207     /**
208      * boolean attribute identifying that an external tool builder has been configured for triggering
209      * using the <code>ICommand.setBuilding(int)</code> mechanism
210      * @since 3.1
211      */
212     public static final String   ATTR_TRIGGERS_CONFIGURED = PLUGIN_ID + ".ATTR_TRIGGERS_CONFIGURED";       //$NON-NLS-1$
213 }
214
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags