Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.project / src / org / eclipse / equinox / internal / provisional / p2 / installer / InstallDescription.java

diff --git a/bundles/org.simantics.project/src/org/eclipse/equinox/internal/provisional/p2/installer/InstallDescription.java b/bundles/org.simantics.project/src/org/eclipse/equinox/internal/provisional/p2/installer/InstallDescription.java
new file mode 100644 (file)
index 0000000..b9c29c7
--- /dev/null
+++ b/bundles/org.simantics.project/src/org/eclipse/equinox/internal/provisional/p2/installer/InstallDescription.java
@@ -0,0 +1,171 @@
+/*******************************************************************************\r
+ *  Copyright (c) 2007, 2009 IBM Corporation and others.\r
+ *  All rights reserved. This program and the accompanying materials\r
+ *  are made available under the terms of the Eclipse Public License v1.0\r
+ *  which accompanies this distribution, and is available at\r
+ *  http://www.eclipse.org/legal/epl-v10.html\r
+ * \r
+ *  Contributors:\r
+ *     IBM Corporation - initial API and implementation\r
+ *     Code 9 - ongoing development\r
+ *******************************************************************************/\r
+package org.eclipse.equinox.internal.provisional.p2.installer;\r
+\r
+import java.net.URI;\r
+import java.util.HashMap;\r
+import java.util.Map;\r
+\r
+import org.eclipse.core.runtime.IPath;\r
+import org.eclipse.equinox.p2.metadata.IVersionedId;\r
+\r
+/**\r
+ * An install information captures all the data needed to perform a product install.\r
+ * This includes information on where the installed product comes from, what will\r
+ * be installed, and where it will be installed.\r
+ */\r
+public class InstallDescription {\r
+       private URI[] artifactRepos;\r
+       private IPath installLocation;\r
+       private IPath agentLocation;\r
+       private IPath bundleLocation;\r
+       private boolean isAutoStart;\r
+       private String launcherName;\r
+       private URI[] metadataRepos;\r
+       private String productName;\r
+       private IVersionedId[] roots;\r
+       private final Map<String, String> profileProperties = new HashMap<String, String>();\r
+\r
+       /**\r
+        * Returns the p2 agent location, or <code>null</code> to indicate\r
+        * the default agent location.\r
+        */\r
+       public IPath getAgentLocation() {\r
+               return agentLocation;\r
+       }\r
+\r
+       /**\r
+        * Returns the locations of the artifact repositories to install from\r
+        * @return a list of artifact repository URLs\r
+        */\r
+       public URI[] getArtifactRepositories() {\r
+               return artifactRepos;\r
+       }\r
+\r
+       /**\r
+        * Returns the bundle pool location, or <code>null</code> to\r
+        * indicate the default bundle pool location.\r
+        */\r
+       public IPath getBundleLocation() {\r
+               return bundleLocation;\r
+       }\r
+\r
+       /**\r
+        * Returns the local file system location to install into.\r
+        * @return a local file system location\r
+        */\r
+       public IPath getInstallLocation() {\r
+               return installLocation;\r
+       }\r
+\r
+       /**\r
+        * Returns the name of the product's launcher executable\r
+        * @return the name of the launcher executable\r
+        */\r
+       public String getLauncherName() {\r
+               return launcherName;\r
+       }\r
+\r
+       /**\r
+        * Returns the locations of the metadata repositories to install from\r
+        * @return a list of metadata repository URLs\r
+        */\r
+       public URI[] getMetadataRepositories() {\r
+               return metadataRepos;\r
+       }\r
+\r
+       /**\r
+        * Returns the profile properties for this install.\r
+        */\r
+       public Map<String, String> getProfileProperties() {\r
+               return profileProperties;\r
+       }\r
+\r
+       /**\r
+        * Returns a human-readable name for this install.\r
+        * @return the name of the product\r
+        */\r
+       public String getProductName() {\r
+               return productName;\r
+       }\r
+\r
+       /**\r
+        * Returns whether the installed product should be started upon successful\r
+        * install.\r
+        * @return <code>true</code> if the product should be started upon successful\r
+        * install, and <code>false</code> otherwise\r
+        */\r
+       public boolean isAutoStart() {\r
+               return isAutoStart;\r
+       }\r
+\r
+       public void setAgentLocation(IPath agentLocation) {\r
+               this.agentLocation = agentLocation;\r
+       }\r
+\r
+       public void setArtifactRepositories(URI[] value) {\r
+               this.artifactRepos = value;\r
+       }\r
+\r
+       public void setAutoStart(boolean value) {\r
+               this.isAutoStart = value;\r
+       }\r
+\r
+       public void setBundleLocation(IPath bundleLocation) {\r
+               this.bundleLocation = bundleLocation;\r
+       }\r
+\r
+       public void setInstallLocation(IPath location) {\r
+               this.installLocation = location;\r
+       }\r
+\r
+       public void setLauncherName(String name) {\r
+               this.launcherName = name;\r
+       }\r
+\r
+       public void setMetadataRepositories(URI[] value) {\r
+               this.metadataRepos = value;\r
+       }\r
+\r
+       /**\r
+        * Supplies a set of profile properties to be added when the profile is created.\r
+        * @param properties the profile properties to be added\r
+        */\r
+       public void setProfileProperties(Map<String, String> properties) {\r
+               profileProperties.putAll(properties);\r
+       }\r
+\r
+       /**\r
+        * Returns the set of roots to be installed for this installation\r
+        * @return the roots to install\r
+        */\r
+       public IVersionedId[] getRoots() {\r
+               return roots;\r
+       }\r
+\r
+       /**\r
+        * Set the list of roots to install\r
+        * @param value the set of roots to install\r
+        */\r
+       public void setRoots(IVersionedId[] value) {\r
+               roots = value;\r
+       }\r
+\r
+       /**\r
+        * Set the name of the product being installed.\r
+        * @param value the new name of the product to install\r
+        */\r
+       public void setProductName(String value) {\r
+               productName = value;\r
+       }\r
+\r
+}\r