IAntLaunchConfigurationConstants


1   /*******************************************************************************
2    * Copyright (c) 2003, 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  
12  package org.eclipse.ant.internal.ui.launchConfigurations;
13  
14  import org.eclipse.ant.internal.ui.IAntUIConstants;
15  import org.eclipse.ui.externaltools.internal.model.IExternalToolConstants;
16  
17  /**
18   * Constant definitions for Ant launch configurations.
19   * <p>
20   * Constant definitions only; not to be implemented.
21   * </p>
22   * @since 3.0
23   */
24  public interface IAntLaunchConfigurationConstants {
25  
26      // ------- Common Ant Launch Configuration Attributes -------
27      /**
28       * String attribute indicating the Ant targets to execute. Default value is
29       * <code>null</code> which indicates that the default target is to be
30       * executed. Format is a comma separated listing of targets.
31       */
32      public static final String   ATTR_ANT_TARGETS = IExternalToolConstants.PLUGIN_ID + ".ATTR_ANT_TARGETS"; //$NON-NLS-1$
33      
34      /**
35       * String attribute indicating the Ant targets to execute after a clean (full build) for an Ant builder. Default value is
36       * <code>null</code> which indicates that the default target is to be
37       * executed. Format is a comma separated listing of targets.
38       * @since 3.1
39       */
40      public static final String   ATTR_ANT_AFTER_CLEAN_TARGETS = IAntUIConstants.PLUGIN_ID + ".ATTR_ANT_AFTER_CLEAN_TARGETS"; //$NON-NLS-1$
41      
42      /**
43       * String attribute indicating the Ant targets to execute during a manual build for an Ant builder. Default value is
44       * <code>null</code> which indicates that the default target is to be
45       * executed. Format is a comma separated listing of targets.
46       * @since 3.1
47       */
48      public static final String   ATTR_ANT_MANUAL_TARGETS = IAntUIConstants.PLUGIN_ID + ".ATTR_ANT_MANUAL_TARGETS"; //$NON-NLS-1$
49      
50      /**
51       * String attribute indicating the Ant targets to execute during an auto build for an Ant builder. Default value is
52       * <code>null</code> which indicates that the default target is to be
53       * executed. Format is a comma separated listing of targets.
54       * @since 3.1
55       */
56      public static final String   ATTR_ANT_AUTO_TARGETS = IAntUIConstants.PLUGIN_ID + ".ATTR_ANT_AUTO_TARGETS"; //$NON-NLS-1$
57      
58      /**
59       * String attribute indicating the Ant targets to execute during a clean for an Ant builder. Default value is
60       * <code>null</code> which indicates that the default target is to be
61       * executed. Format is a comma separated listing of targets.
62       * @since 3.1
63       */
64      public static final String   ATTR_ANT_CLEAN_TARGETS = IAntUIConstants.PLUGIN_ID + ".ATTR_ANT_CLEAN_TARGETS"; //$NON-NLS-1$
65      
66      /**
67       * Boolean attribute indicating whether or not target specification for an Ant builder has been updated for
68       * 3.1 
69       * 
70       * @since 3.1
71       */
72      public static final String   ATTR_TARGETS_UPDATED = IAntUIConstants.PLUGIN_ID + ".ATTR_TARGETS_UPDATED"; //$NON-NLS-1$
73      
74      /**
75       * Map attribute indicating the Ant properties to be defined during the
76       * build. Default value is <code>null</code> which indicates no additional
77       * properties will be defined.
78       */
79      public static final String   ATTR_ANT_PROPERTIES = IExternalToolConstants.PLUGIN_ID + ".ATTR_ANT_PROPERTIES"; //$NON-NLS-1$                   
80      /**
81       * String attribute indicating the Ant targets to execute. Default value is
82       * <code>null</code> which indicates that no additional property files
83       * will be defined. Format is a comma separated listing of property files.
84       */
85      public static final String   ATTR_ANT_PROPERTY_FILES = IExternalToolConstants.PLUGIN_ID + ".ATTR_ANT_PROPERTY_FILES"; //$NON-NLS-1$
86      /**
87      * String attribute indicating the custom runtime classpath to use for an Ant
88      * build. Default value is <code>null</code> which indicates that the global
89      * classpath is to be used. Format is a comma separated listing of URLs.
90      * @deprecated no longer supported
91      */
92      public static final String   ATTR_ANT_CUSTOM_CLASSPATH = IExternalToolConstants.PLUGIN_ID + ".ATTR_ANT_CUSTOM_CLASSPATH"; //$NON-NLS-1$
93      /**
94       * String attribute indicating the custom Ant home to use for an Ant build.
95       * Default value is <code>null</code> which indicates that no Ant home is to
96       * be set 
97       * @deprecated no longer supported
98       */
99      public static final String   ATTR_ANT_HOME = IExternalToolConstants.PLUGIN_ID + ".ATTR_ANT_HOME"; //$NON-NLS-1$
100     /**
101      * Boolean attribute indicating whether or not internal targets (targets with no
102      * description) should be hidden from the user in the launch configuration dialog.
103      * Default value is <code>false</code> which indicates that all targets will be
104      * displayed.
105      * 
106      * @since 3.0
107      */
108     public static final String   ATTR_HIDE_INTERNAL_TARGETS = IExternalToolConstants.PLUGIN_ID + ".ATTR_HIDE_INTERNAL_TARGETS"; //$NON-NLS-1$
109     /**
110      * Integer attribute indicating which column targets should be sorted on. A
111      * value of 0 indicates target name, 1 indicates target description, and -1
112      * indicates no sort. Default value is -1.
113      * 
114      * @since 3.0
115      */
116     public static final String   ATTR_SORT_TARGETS = IExternalToolConstants.PLUGIN_ID + "ATTR_SORT_TARGETS"; //$NON-NLS-1$
117 
118 
119     // ------- Launch configuration types --------
120     /**
121      * Ant launch configuration type identifier.
122      */
123     public static final String   ID_ANT_LAUNCH_CONFIGURATION_TYPE = "org.eclipse.ant.AntLaunchConfigurationType"; //$NON-NLS-1$
124 
125     /**
126      * Ant builder launch configuration type identifier. Ant project builders
127      * are of this type.
128      */
129     public static final String   ID_ANT_BUILDER_LAUNCH_CONFIGURATION_TYPE = "org.eclipse.ant.AntBuilderLaunchConfigurationType"; //$NON-NLS-1$
130 
131     /**
132      * Identifier for Ant processes (value <code>org.eclipse.ant.ui.antProcess</code>). This identifier is
133      * set as the value for the <code>IProcess.ATTR_PROCESS_TYPE</code>
134      * attribute in processes created by the Ant launch delegate.
135      */
136     public static final String   ID_ANT_PROCESS_TYPE = "org.eclipse.ant.ui.antProcess"; //$NON-NLS-1$
137 }
138
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags