IPDEBuildConstants


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 - Initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.pde.internal.build;
12  
13  /**
14   * Generic constants for this plug-in classes.
15   */
16  public interface IPDEBuildConstants {
17  
18      /** PDE Core plug-in id */
19      public static final String   PI_BOOT = "org.eclipse.core.boot"; //$NON-NLS-1$
20      public static final String   PI_BOOT_JAR_NAME = "boot.jar"; //$NON-NLS-1$
21      public static final String   PI_PDEBUILD = "org.eclipse.pde.build"; //$NON-NLS-1$
22      public static final String   PI_RUNTIME = "org.eclipse.core.runtime"; //$NON-NLS-1$
23      public static final String   PI_RUNTIME_JAR_NAME = "runtime.jar"; //$NON-NLS-1$
24  
25      /** file names */
26      public final static String   PROPERTIES_FILE = "build.properties"; //$NON-NLS-1$
27      public final static String   PERMISSIONS_FILE = "permissions.properties"; //$NON-NLS-1$
28      public final static String   ABOUT_HTML_FILE = "about.html"; //$NON-NLS-1$
29      public final static String   FEATURE_PROPERTIES_FILE = "feature.properties"; //$NON-NLS-1$
30      public final static String   SOURCE_PLUGIN_ATTRIBUTE = "sourcePlugin"; //$NON-NLS-1$
31      public final static String   MANIFEST_FOLDER = "META-INF"; //$NON-NLS-1$
32      public final static String   MANIFEST = "MANIFEST.MF"; //$NON-NLS-1$
33  
34      // default values
35      public final static String   DEFAULT_BUILD_SCRIPT_FILENAME = "build.xml"; //$NON-NLS-1$
36      public final static String   DEFAULT_FEATURE_LOCATION = "features"; //$NON-NLS-1$
37      public final static String   DEFAULT_FETCH_SCRIPT_FILENAME = "fetch.xml"; //$NON-NLS-1$
38      public final static String   DEFAULT_ASSEMBLE_FILENAME = "assemble.xml"; //$NON-NLS-1$
39      public final static String   DEFAULT_PLUGIN_LOCATION = "plugins"; //$NON-NLS-1$
40      public final static String   DEFAULT_TEMPLATE_SCRIPT_FILENAME = "template.xml"; //$NON-NLS-1$
41      public final static String   GENERIC_VERSION_NUMBER = "0.0.0"; //$NON-NLS-1$ 
42      public final static String   ANY_STRING = "ANY"; //$NON-NLS-1$
43      public final static String   DEFAULT_ASSEMBLE_NAME = "assemble"; //$NON-NLS-1$
44      public final static String   DEFAULT_ASSEMBLE_ALL = "all.xml"; //$NON-NLS-1$
45      public final static String   DEFAULT_CUSTOM_TARGETS = "customTargets"; //$NON-NLS-1$
46      public final static String   DEFAULT_RETRIEVE_FILENAME_DESCRIPTOR = "retrieve.xml"; //$NON-NLS-1$
47      public final static String   DEFAULT_ISV_DOC_PLUGIN_SUFFIX = "doc.isv"; //$NON-NLS-1$
48      public final static String   DEFAULT_SOURCE_PLUGIN_SUFFIX = "source"; //$NON-NLS-1$
49      public final static String   DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR = "packager.directory.txt"; //$NON-NLS-1$
50      public final static String   DEFAULT_UNZIPPER_FILENAME_DESCRIPTOR = "unzipper.xml"; //$NON-NLS-1$
51      public final static String   DEFAULT_PLUGIN_REPOTAG_FILENAME_DESCRIPTOR = "pluginVersions.properties"; //$NON-NLS-1$
52      public final static String   DEFAULT_FEATURE_REPOTAG_FILENAME_DESCRIPTOR = "featureVersions.properties"; //$NON-NLS-1$
53      public final static String   DEFAULT_PLUGINS_POSTPROCESSINGSTEPS_FILENAME_DESCRIPTOR = "plugins.postProcessingSteps.properties"; //$NON-NLS-1$
54      public final static String   DEFAULT_FEATURES_POSTPROCESSINGSTEPS_FILENAME_DESCRIPTOR = "features.postProcessingSteps.properties"; //$NON-NLS-1$
55      public final static String   DEFAULT_CUSTOM_BUILD_CALLBACKS_FILE = "customBuildCallbacks.xml"; //$NON-NLS-1$
56      public final static String   DEFAULT_PRODUCT_ROOT_FILES_DIR = "productRootFiles"; //$NON-NLS-1$
57  
58      public final static String   DEFAULT_PLUGIN_VERSION_FILENAME_PREFIX = "finalPluginsVersions"; //$NON-NLS-1$
59      public final static String   DEFAULT_FEATURE_VERSION_FILENAME_PREFIX = "finalFeaturesVersions"; //$NON-NLS-1$
60      public final static String   PROPERTIES_FILE_SUFFIX = ".properties"; //$NON-NLS-1$
61      
62      // Tag replaced in files
63      public final static String   REPLACED_PLUGIN_ID = "PLUGIN_ID"; //$NON-NLS-1$
64      public final static String   REPLACED_PLUGIN_VERSION = "PLUGIN_VERSION"; //$NON-NLS-1$
65      public final static String   REPLACED_FRAGMENT_VERSION = "FRAGMENT_VERSION"; //$NON-NLS-1$ 
66      public final static String   REPLACED_FRAGMENT_ID = "FRAGMENT_ID"; //$NON-NLS-1$
67      public final static String   REPLACED_PLATFORM_FILTER = "PLATFORM_FILTER"; //$NON-NLS-1$
68      
69      // status constants 
70      public final static int EXCEPTION_FEATURE_MISSING = 1;
71      public final static int EXCEPTION_BUILDDIRECTORY_LOCATION_MISSING = 2;
72      public final static int EXCEPTION_MALFORMED_URL = 3;
73      public final static int EXCEPTION_MODEL_PARSE = 4;
74      public final static int EXCEPTION_PLUGIN_MISSING = 5;
75      public final static int EXCEPTION_READ_DIRECTORY = 6;
76      public final static int EXCEPTION_WRITING_SCRIPT = 7;
77      public final static int EXCEPTION_ELEMENT_MISSING = 8;
78      public final static int EXCEPTION_ENTRY_MISSING = 9;
79      public final static int EXCEPTION_READING_FILE = 10;
80      public final static int EXCEPTION_SOURCE_LOCATION_MISSING = 11;
81      public final static int EXCEPTION_WRITING_FILE = 12;
82      public final static int EXCEPTION_INVALID_JAR_ORDER = 13;
83      public final static int EXCEPTION_CLASSPATH_CYCLE = 14;
84      public final static int EXCEPTION_STATE_PROBLEM = 15;
85      public final static int EXCEPTION_GENERIC = 16;
86      public final static int EXCEPTION_FEATURE_PARSE = 17;
87      public final static int WARNING_MISSING_SOURCE = 20;
88      public final static int WARNING_ELEMENT_NOT_FETCHED = 21;
89      public final static int EXCEPTION_CONFIG_FORMAT = 22;
90      public final static int EXCEPTION_PRODUCT_FORMAT = 23;
91      public final static int EXCEPTION_PRODUCT_FILE = 24;
92      public final static int WARNING_PLUGIN_ALTERED = 25;
93      
94      //User object keys. BundleDescription.getUserObject()
95      public final static String   IS_COMPILED = "isCompiler"; //$NON-NLS-1$
96      public final static String   PLUGIN_ENTRY = "pluginEntry"; //$NON-NLS-1$
97      public final static String   WITH_DOT = "withDot";  //$NON-NLS-1$
98      
99      //Filter properties
100     public final static String   OSGI_WS = "osgi.ws";  //$NON-NLS-1$
101     public final static String   OSGI_OS = "osgi.os";  //$NON-NLS-1$
102     public final static String   OSGI_ARCH = "osgi.arch";  //$NON-NLS-1$
103     public final static String   OSGI_NL = "osgi.nl";  //$NON-NLS-1$
104     
105     //Eclipse specific manifest headers
106     public final static String   EXTENSIBLE_API = "Eclipse-ExtensibleAPI";  //$NON-NLS-1$
107     public final static String   PATCH_FRAGMENT = "Eclipse-PatchFragment"; //$NON-NLS-1$
108     
109     // fetch task extension point
110     public final static String   EXT_FETCH_TASK_FACTORIES = "org.eclipse.pde.build.fetchFactories"; //$NON-NLS-1$
111     public final static String   ATTR_ID = "id"; //$NON-NLS-1$
112     public final static String   ATTR_CLASS = "class"; //$NON-NLS-1$
113     public final static String   ELEM_FACTORY = "factory"; //$NON-NLS-1$
114     
115     //container feature used in building .product files
116     public final static String   CONTAINER_FEATURE = "org.eclipse.pde.build.container.feature"; //$NON-NLS-1$
117 }
118
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags