Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Niefer2007-05-23 18:25:46 +0000
committerAndrew Niefer2007-05-23 18:25:46 +0000
commit312eb675efeb0d053e58f16f33481a3bd35d1709 (patch)
treeac83f91805b338e8794d8112fa680dcf77f18d84 /bundles/org.eclipse.equinox.launcher/src
parent6c5c6dbb6aeed1d902cc804313b6d9d5ff8685b5 (diff)
downloadrt.equinox.framework-312eb675efeb0d053e58f16f33481a3bd35d1709.tar.gz
rt.equinox.framework-312eb675efeb0d053e58f16f33481a3bd35d1709.tar.xz
rt.equinox.framework-312eb675efeb0d053e58f16f33481a3bd35d1709.zip
bug 188678
Diffstat (limited to 'bundles/org.eclipse.equinox.launcher/src')
-rw-r--r--bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/Main.java10
-rw-r--r--bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/package.html8
-rw-r--r--bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/JNIBridge.java7
-rw-r--r--bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/Main.java6
-rw-r--r--bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/WebStartMain.java10
-rw-r--r--bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/package.html8
6 files changed, 39 insertions, 10 deletions
diff --git a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/Main.java b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/Main.java
index 87a35a97f..eb3e600fc 100644
--- a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/Main.java
+++ b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/Main.java
@@ -11,8 +11,14 @@
package org.eclipse.core.launcher;
/**
- * Main class for backwards compatibility.
- * The real Main class is now org.eclipse.equinox.launcher.Main
+ * This class exists only for backwards compatibility.
+ * The real Main class is now org.eclipse.equinox.launcher.Main.
+ * <p>
+ * <b>Note:</b> This class should not be referenced programmatically by
+ * other Java code. This class exists only for the purpose of launching Eclipse
+ * from the command line. To launch Eclipse programmatically, use
+ * org.eclipse.core.runtime.adaptor.EclipseStarter. The fields and methods
+ * on this class are not API.
*/
public class Main {
diff --git a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/package.html b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/package.html
index fdde224e1..d329929ea 100644
--- a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/package.html
+++ b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/core/launcher/package.html
@@ -11,8 +11,12 @@ Launches the Eclipse Platform.
<h2>
Package Specification</h2>
-This package exists for backwards compatibility. To start the platform invoke the org.eclipse.equinox.launcher.Main
-class.
+This package exists for backwards compatibility. To start the platform, specify org.eclipse.equinox.launcher.Main
+as the main class when invoking the Java VM.
+<p>
+This package is not intended to be used by other Java code. The methods
+and fields in these classes are not API.
+
<br>&nbsp;
</body>
</html>
diff --git a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/JNIBridge.java b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/JNIBridge.java
index cd45d223b..1b549e5da 100644
--- a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/JNIBridge.java
+++ b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/JNIBridge.java
@@ -12,10 +12,13 @@ package org.eclipse.equinox.launcher;
/**
- * @author aniefer
- *
+ * <b>Note:</b> This class should not be referenced programmatically by
+ * other Java code. This class exists only for the purpose of interacting with
+ * a native launcher. To launch Eclipse programmatically, use
+ * org.eclipse.core.runtime.adaptor.EclipseStarter. This class is not API.
*/
public class JNIBridge {
+ //TODO: This class should not be public
private native void _set_exit_data(String sharedId, String data);
private native void _update_splash();
private native long _get_splash_handle();
diff --git a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/Main.java b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/Main.java
index 507532112..6afd477fc 100644
--- a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/Main.java
+++ b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/Main.java
@@ -22,6 +22,12 @@ import org.eclipse.equinox.internal.launcher.Constants;
/**
* The launcher for Eclipse.
+ *
+ * <b>Note:</b> This class should not be referenced programmatically by
+ * other Java code. This class exists only for the purpose of launching Eclipse
+ * from the command line. To launch Eclipse programmatically, use
+ * org.eclipse.core.runtime.adaptor.EclipseStarter. The fields and methods
+ * on this class are not API.
*/
public class Main {
/**
diff --git a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/WebStartMain.java b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/WebStartMain.java
index 65e8bc4ca..9e9e5a1a5 100644
--- a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/WebStartMain.java
+++ b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/WebStartMain.java
@@ -25,8 +25,14 @@ import java.util.jar.JarFile;
import java.util.jar.Manifest;
/**
- * The launcher to start eclipse using webstart.
- * To use this launcher, the client must accept to give all security permissions.
+ * The launcher to start eclipse using webstart. To use this launcher, the client
+ * must accept to give all security permissions.
+ * <p>
+ * <b>Note:</b> This class should not be referenced programmatically by
+ * other Java code. This class exists only for the purpose of launching Eclipse
+ * using Java webstart. To launch Eclipse programmatically, use
+ * org.eclipse.core.runtime.adaptor.EclipseStarter. The fields and methods
+ * on this class are not API.
*/
//The bundles are discovered by finding all the jars on the classpath. Then they are added with their full path to the osgi.bundles list.
public class WebStartMain extends Main {
diff --git a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/package.html b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/package.html
index ca2e7ce0c..cecfa7292 100644
--- a/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/package.html
+++ b/bundles/org.eclipse.equinox.launcher/src/org/eclipse/equinox/launcher/package.html
@@ -11,8 +11,12 @@ Launches the Eclipse Platform.
<h2>
Package Specification</h2>
-This package is the main entry point to the Eclipse Platform. To start the platform invoke the Main
-class in this package.
+This package contains classes for launching the Eclipse Platform from a command
+line or through Java web start. To start the platform, specify the Main class in this package
+when invoking the Java VM.
+<p>
+This package is not intended to be used by other Java code. The methods
+and fields in these classes are not API.
<br>&nbsp;
</body>
</html>

Back to the top