IPDEConstants.java

package org.eclipse.buckminster.pde;

import java.util.regex.Pattern;

import org.eclipse.buckminster.core.KeyConstants;
import org.eclipse.buckminster.core.cspec.WellKnownExports;
import org.eclipse.buckminster.core.cspec.WellknownActions;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.pde.internal.build.IPDEBuildConstants;

@SuppressWarnings("restriction")
public interface IPDEConstants {
	static final String ABOUT_MAPPINGS_FILE = "about.mappings"; //$NON-NLS-1$

	static final String ACTION_ABOUT_MAPPINGS = ABOUT_MAPPINGS_FILE;

	static final String ACTION_GENERATE_API_DESCRIPTION = "generate.api.description"; //$NON-NLS-1$

	static final String ACTION_COPY_BINARIES = "copy.binaries"; //$NON-NLS-1$

	static final String ACTION_COPY_FEATURES = "copy.features"; //$NON-NLS-1$

	static final String ACTION_COPY_PLUGINS = "copy.plugins"; //$NON-NLS-1$

	static final String ACTION_COPY_SITE_FEATURES = "copy.subfeatures"; //$NON-NLS-1$

	static final String ACTOR_COPY_TARGET_FRAGMENTS = "copyTargetFragments"; //$NON-NLS-1$

	static final String ACTOR_P2_SITE_GENERATOR = "p2SiteGenerator"; //$NON-NLS-1$

	static final String ALIAS_BINARY = "binary"; //$NON-NLS-1$

	static final String ALIAS_SOURCE = "source"; //$NON-NLS-1$

	static final String ALIAS_BUNDLES = "bundles"; //$NON-NLS-1$

	static final String ALIAS_FEATURES = "features"; //$NON-NLS-1$

	static final String ALIAS_MANIFEST = "manifest"; //$NON-NLS-1$

	static final String ALIAS_TRANSLATIONS = "translations"; //$NON-NLS-1$

	static final String ALIAS_OUTPUT = "action.output"; //$NON-NLS-1$

	static final String ALIAS_PROPERTIES = "properties"; //$NON-NLS-1$

	static final String ALIAS_REQUIREMENTS = "action.requirements"; //$NON-NLS-1$

	static final String ATTRIBUTE_BUILD_PROPERTIES = "build.properties"; //$NON-NLS-1$

	static final String ALIAS_LICENSE_FEATURE = "license.feature"; //$NON-NLS-1$

	static final String ALIAS_LICENSE_MANIFEST = "license.manifest"; //$NON-NLS-1$

	static final String ALIAS_LICENSE_FEATURE_CONTENTS = "license.feature.contents"; //$NON-NLS-1$

	/**
	 * Denotes a fully deployable bundle in jar format plus fragments from the
	 * target platform
	 */
	static final String ATTRIBUTE_BUNDLE_AND_FRAGMENTS = "bundle.and.fragments"; //$NON-NLS-1$

	static final String ATTRIBUTE_BUNDLE_AND_FRAGMENTS_SOURCE = "bundle.and.fragments.source"; //$NON-NLS-1$

	/**
	 * Denotes the bundle classpath. This will be the sum of all exported
	 * binaries from the imported bundles plus the full contribution of this
	 * bundle.
	 */
	static final String ATTRIBUTE_BUNDLE_CLASSPATH = "bundle.classpath"; //$NON-NLS-1$

	/**
	 * Denotes a bundle in unpacked format
	 */
	static final String ATTRIBUTE_BUNDLE_FOLDER = "bundle.folder"; //$NON-NLS-1$

	/**
	 * Denotes a fully deployable bundle in jar format
	 */
	static final String ATTRIBUTE_BUNDLE_JAR = "bundle.jar"; //$NON-NLS-1$

	/**
	 * Denotes a list consisting of a fully deployable bundle in jar format
	 * along with all bundles that it re-exports, also in jar format.
	 */
	static final String ATTRIBUTE_BUNDLE_JARS = "bundle.jars"; //$NON-NLS-1$

	/**
	 * Denotes group consisting of this feature and all included features and
	 * bundles in a format suitable for publishing on an update The base of the
	 * attribute
	 * 
	 * @{link org.eclipse.buckminster.core.cspec.PathGroup PathGroup} will be
	 *        folder that contains the <code>features</code> and
	 *        <code>plugins</code> folders.
	 */
	static final String ATTRIBUTE_FEATURE_EXPORTS = "feature.exports"; //$NON-NLS-1$

	/**
	 * The feature in a format suitable for an update site. No sub-features nor
	 * bundles are included. The base of the attribute
	 * 
	 * @{link org.eclipse.buckminster.core.cspec.PathGroup PathGroup} will be
	 *        the folder containing the feature.
	 */
	static final String ATTRIBUTE_FEATURE_JAR = "feature.jar"; //$NON-NLS-1$

	/**
	 * Denotes group consisting of this feature in jar format and all included
	 * features, also in jar format.
	 */
	static final String ATTRIBUTE_FEATURE_JARS = "feature.jars"; //$NON-NLS-1$

	static final String ATTRIBUTE_FEATURE_REFS = "feature.references"; //$NON-NLS-1$

	/**
	 * The attribut that, when triggered, will clean out all built artifacts
	 * including the Eclipse build. This attribute has no resulting product.
	 */
	static final String ATTRIBUTE_FULL_CLEAN = WellknownActions.BUCKMINSTER.CLEAN.toString();

	/**
	 * Denotes a fully deployable bundle in jar format imported into a wrapper
	 * using import
	 */
	static final String ATTRIBUTE_IMPORTED_JAR = "imported.jar"; //$NON-NLS-1$

	static final String ATTRIBUTE_JAR_CONTENTS = "jar.contents"; //$NON-NLS-1$

	static final String ATTRIBUTE_BIN_INCLUDES = "bin.includes"; //$NON-NLS-1$

	static final String ATTRIBUTE_SRC_INCLUDES = "src.includes"; //$NON-NLS-1$

	/**
	 * Denotes the external classpath for the bundle. This will be the sum of
	 * all exported binaries from the imported bundles plus the exported
	 * contribution of this bundle.
	 */
	static final String ATTRIBUTE_JAVA_BINARIES = WellKnownExports.JAVA_BINARIES;

	static final String ATTRIBUTE_MANIFEST = "manifest"; //$NON-NLS-1$

	static final String ATTRIBUTE_TRANSLATIONS = "translations"; //$NON-NLS-1$

	/**
	 * Denotes a list consisting of all product configurations contained in the
	 * bundle or feature together with all product configurations exported by
	 * dependent bundles or features
	 */
	static final String ATTRIBUTE_PRODUCT_CONFIG_EXPORTS = "product.configuration.exports"; //$NON-NLS-1$

	/**
	 * Denotes a list consisting of all product configurations contained in the
	 * bundle or feature
	 */
	static final String ATTRIBUTE_PRODUCT_CONFIGS = "product.configurations"; //$NON-NLS-1$

	static final String ATTRIBUTE_RAW_ABOUT_MAPPINGS = "raw.about.mappings"; //$NON-NLS-1$

	static final String ATTRIBUTE_RAW_MANIFEST = "raw.manifest"; //$NON-NLS-1$

	static final String ATTRIBUTE_VERSIONED_MANIFEST = "versioned.manifest"; //$NON-NLS-1$

	/**
	 * <p>
	 * Denotes group consisting all included features and bundles, but excluding
	 * this feature, in a format suitable for publishing on an update site. The
	 * base of the attribute.
	 * </p>
	 * <p>
	 * This group is intended to be used when the feature describes a site and
	 * the feature itself thus should not be considered unit in that site.
	 * </p>
	 * 
	 * @{link org.eclipse.buckminster.core.cspec.PathGroup PathGroup} will be
	 *        folder that contains the <code>features</code> and
	 *        <code>plugins</code> folders.
	 */
	static final String ATTRIBUTE_SITE_FEATURE_EXPORTS = "site.feature.exports"; //$NON-NLS-1$

	/**
	 * Zipped site.
	 */
	static final String ATTRIBUTE_SITE_ZIP = "site.p2.zip"; //$NON-NLS-1$

	/**
	 * Site with p2 meta-data.
	 */
	static final String ATTRIBUTE_SITE_P2 = "site.p2"; //$NON-NLS-1$

	/**
	 * Site packed with pack200
	 */
	static final String ATTRIBUTE_SITE_PACKED = "site.packed"; //$NON-NLS-1$

	/**
	 * Site repacked by pack200 and ready for signing
	 */
	static final String ATTRIBUTE_SITE_REPACKED = "site.repacked"; //$NON-NLS-1$

	/**
	 * Signed site
	 */
	static final String ATTRIBUTE_SITE_SIGNED = "site.signed"; //$NON-NLS-1$

	static final String ATTRIBUTE_SOURCE_BUNDLE_JAR = "source.bundle.jar"; //$NON-NLS-1$

	/**
	 * Denotes a list consisting of all source bundle jar files provided by a
	 * feature.
	 */
	static final String ATTRIBUTE_SOURCE_BUNDLE_JARS = "source.bundle.jars"; //$NON-NLS-1$

	static final String ATTRIBUTE_SOURCE_FEATURE_JAR = "source.feature.jar"; //$NON-NLS-1$

	static final String ATTRIBUTE_SOURCE_FEATURE_JARS = "source.feature.jars"; //$NON-NLS-1$

	static final String ATTRIBUTE_SOURCE_FEATURE_REFS = "source.feature.references"; //$NON-NLS-1$

	static final String ATTRIBUTE_SOURCE_MANIFEST = "source.manifest"; //$NON-NLS-1$

	static final String ATTRIBUTE_SOURCE_LOCALIZATION = "source.localization"; //$NON-NLS-1$

	/**
	 * Appoints an action that will copy the fragments for the current component
	 * from the workspace or target platform
	 */
	static final String ATTRIBUTE_TARGET_FRAGMENTS = "target.fragments"; //$NON-NLS-1$

	static final String ATTRIBUTE_TARGET_FRAGMENTS_SOURCE = "target.fragments.source"; //$NON-NLS-1$

	static final String BUILD_FILE_ID = "buckminster.pdetasks"; //$NON-NLS-1$

	static final String BUILD_PROPERTIES_FILE = IPDEBuildConstants.PROPERTIES_FILE;

	static final String BUNDLE_FILE = IPDEBuildConstants.MANIFEST_FOLDER + '/' + IPDEBuildConstants.MANIFEST;

	static final String FEATURE_MANIFEST = "feature.xml"; //$NON-NLS-1$

	static final String FEATURE_PROPERTIES = "feature.properties"; //$NON-NLS-1$

	public static final String FEATURE_GROUP = ".feature.group"; //$NON-NLS-1$

	static final String FEATURE_NATURE = "org.eclipse.pde.FeatureNature"; //$NON-NLS-1$

	static final String FEATURE_PROPERTIES_FILE = "feature.properties"; //$NON-NLS-1$

	static final String FEATURES_FOLDER = IPDEBuildConstants.DEFAULT_FEATURE_LOCATION;

	static final String FEATURE_WITH_LICENSE_FOLDER = "feature.with.license"; //$NON-NLS-1$

	static final String FRAGMENT_FILE = "fragment.xml"; //$NON-NLS-1$

	static final String MANIFEST = IPDEBuildConstants.MANIFEST;

	static final String MANIFEST_HEADER_SOURCE_BUNDLE = "Eclipse-SourceBundle"; //$NON-NLS-1$

	static final IPath OUTPUT_DIR = new Path(KeyConstants.ACTION_OUTPUT_REF + '/');

	static final String PLUGIN_FILE = "plugin.xml"; //$NON-NLS-1$

	static final String PLUGIN_NATURE = "org.eclipse.pde.PluginNature"; //$NON-NLS-1$

	static final String PLUGIN_PROPERTIES_FILE = "plugin.properties"; //$NON-NLS-1$

	static final String PLUGINS_FOLDER = IPDEBuildConstants.DEFAULT_PLUGIN_LOCATION;

	static final Pattern PRODUCT_CONFIGURATION_FILE_PATTERN = Pattern.compile("^.*\\.product$"); //$NON-NLS-1$

	static final String PROP_DELETE_DIR = "dir.to.delete"; //$NON-NLS-1$

	static final String PROP_DELETE_FILE = "file.to.delete"; //$NON-NLS-1$

	static final String PROP_PRODUCT_FILE = "buckminster.eclipse.productFile"; //$NON-NLS-1$

	static final String PROP_PDE_MATCH_RULE_DEFAULT = "pde.match.rule.default"; //$NON-NLS-1$

	static final String PROP_PDE_MATCH_RULE_DEFAULT_LOWER = "pde.match.rule.default.lower"; //$NON-NLS-1$

	static final String PROP_PDE_MATCH_RULE_BUNDLE = "pde.match.rule.bundle"; //$NON-NLS-1$

	static final String PROP_PDE_MATCH_RULE_BUNDLE_LOWER = "pde.match.rule.bundle.lower"; //$NON-NLS-1$

	static final String PROP_PDE_MATCH_RULE_FEATURE = "pde.match.rule.feature"; //$NON-NLS-1$

	static final String PROP_PDE_MATCH_RULE_FEATURE_LOWER = "pde.match.rule.feature.lower"; //$NON-NLS-1$

	/**
	 * @deprecated Use {@link #PDE_MATCH_RULE_DEFAULT_LOWER}
	 */
	@Deprecated
	static final String PROP_PDE_MATCH_RULE_RETAIN_LOWER = "pde.match.rule.retain.lower"; //$NON-NLS-1$

	static final String PROP_PDE_BUNDLE_RANGE_GENERATION = "pde.bundle.range.generation"; //$NON-NLS-1$

	static final String PROP_PDE_CONSIDER_ABOUT_MAPPINGS = "pde.consider.about.mappings"; //$NON-NLS-1$

	static final String PROP_PDE_FEATURE_REQUIREMENTS_GREEDY = "pde.feature.requirements.greedy"; //$NON-NLS-1$

	static final Object PROP_PDE_SOURCE_BUNDLE_LABEL_FORMAT = "pde.source.bundle.label.format"; //$NON-NLS-1$

	static final Object PROP_PDE_SOURCE_FEATURE_LABEL_FORMAT = "pde.source.feature.label.format"; //$NON-NLS-1$

	static final Object PROP_PDE_SOURCE_FEATURE_DESCRIPTION_FORMAT = "pde.source.feature.description.format"; //$NON-NLS-1$

	static boolean PDE_BUNDLE_RANGE_GENERATION_DEFAULT = true;

	static final String PROP_PDE_FEATURE_RANGE_GENERATION = "pde.feature.range.generation"; //$NON-NLS-1$

	static boolean PDE_FEATURE_RANGE_GENERATION_DEFAULT = true;

	static final String SITE_FILE = "site.xml"; //$NON-NLS-1$

	static final String SOURCE_MANIFEST = "SOURCE_" + IPDEBuildConstants.MANIFEST; //$NON-NLS-1$

	static final String TASK_COPY_GROUP = "copy.group"; //$NON-NLS-1$

	static final String TASK_CREATE_BUNDLE_JAR = "create.bundle.jar"; //$NON-NLS-1$

	static final String TASK_CREATE_ECLIPSE_PRODUCT = "create.eclipse.product"; //$NON-NLS-1$

	static final String TASK_CREATE_FEATURE_JAR = "create.feature.jar"; //$NON-NLS-1$

	static final String TASK_CREATE_JAR = "create.jar"; //$NON-NLS-1$

	static final String TASK_CREATE_SITE_ZIP = "create.site.zip"; //$NON-NLS-1$

	static final String TASK_CREATE_JAR_WM = "create.jar.with.manifest"; //$NON-NLS-1$

	static final String TASK_CREATE_SOURCE_FEATURE = "create.source.feature"; //$NON-NLS-1$

	static final String TASK_CREATE_SOURCE_MANIFEST = "create.source.manifest"; //$NON-NLS-1$

	static final String TASK_CREATE_ZIP = "create.zip"; //$NON-NLS-1$

	static final String TASK_DELETE_DIR = "delete.dir"; //$NON-NLS-1$

	static final String TASK_DELETE_FILE = "delete.file"; //$NON-NLS-1$

	static final String TASK_DELETE_GROUP = "delete.group"; //$NON-NLS-1$

	static final String TASK_EXPAND_BUNDLE_VERSION = "expand.bundle.version"; //$NON-NLS-1$

	static final String TASK_EXPAND_FEATURE_VERSION = "expand.feature.version"; //$NON-NLS-1$

	static final String TASK_RECREATE_JAR = "recreate.jar"; //$NON-NLS-1$

	static final String TASK_REPLACE_TOKEN = "replaceToken"; //$NON-NLS-1$

	static final String TASK_REPLACE_TWO_TOKENS = "replaceTwoTokens"; //$NON-NLS-1$

	static final String TASK_REPLACE_THREE_TOKENS = "replaceThreeTokens"; //$NON-NLS-1$

	static final String TASK_API_GENERATION = "apigeneration"; //$NON-NLS-1$

	static final String TASK_UNJAR_NAMED = "unjar.named"; //$NON-NLS-1$

	static final String TASK_UNZIP = "unzip"; //$NON-NLS-1$

	static final IPath TEMP_DIR = new Path(KeyConstants.ACTION_TEMPDIR_REF + '/');

	static final String TOP_FOLDER_SUFFIX = ".topfolder"; //$NON-NLS-1$

	public static final IPath OUTPUT_DIR_SITE_P2 = OUTPUT_DIR.append(ATTRIBUTE_SITE_P2);

	public static final IPath OUTPUT_DIR_SITE_ZIP = OUTPUT_DIR.append(ATTRIBUTE_SITE_ZIP);
}