Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDJ Houghton2005-05-26 12:04:26 +0000
committerDJ Houghton2005-05-26 12:04:26 +0000
commitca876725eaefd6c0ce6d9996cf76a4206ab9cd04 (patch)
tree9b2952b5d2ec787da3d5f3711d876b5b143ea19c
parentfd1274c4c47165a77610054e29091f7d677ef5f1 (diff)
downloadrt.equinox.framework-ca876725eaefd6c0ce6d9996cf76a4206ab9cd04.tar.gz
rt.equinox.framework-ca876725eaefd6c0ce6d9996cf76a4206ab9cd04.tar.xz
rt.equinox.framework-ca876725eaefd6c0ce6d9996cf76a4206ab9cd04.zip
Javadoc clean-up
-rw-r--r--bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java2
-rw-r--r--bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/localization/BundleLocalization.java13
-rw-r--r--bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java31
-rw-r--r--bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java12
-rw-r--r--bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/urlconversion/URLConverter.java12
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java13
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java12
7 files changed, 71 insertions, 24 deletions
diff --git a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java
index 923a7040b..a842274c5 100644
--- a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java
+++ b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java
@@ -66,7 +66,7 @@ public interface EnvironmentInfo {
/**
* Returns the string name of the current operating system for use in finding
- * files whose path starts with <code>$os$</code>. Return <code>OS_UNKNOWN</code>
+ * files whose path starts with <code>$os$</code>. Return {@link Constants#OS_UNKNOWN}
* if the operating system cannot be determined.
* <p>
* The value may indicate one of the operating systems known to the platform
diff --git a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/localization/BundleLocalization.java b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/localization/BundleLocalization.java
index 65748e5dd..7e4fa4586 100644
--- a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/localization/BundleLocalization.java
+++ b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/localization/BundleLocalization.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
+ * Copyright (c) 2004, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -14,18 +14,21 @@ import java.util.ResourceBundle;
import org.osgi.framework.Bundle;
/**
- * The interface of the service that gets ResourceBundle objects from a given
+ * The interface of the service that gets {@link ResourceBundle} objects from a given
* bundle with a given locale.
+ * <p>
+ * This interface is not intended to be implemented by clients.
+ * </p>
+ * @since 3.1
*/
public interface BundleLocalization {
+
/**
* The getLocalization method gets a ResourceBundle object for the given
* locale and bundle.
*
- *
* @return A <code>ResourceBundle</code> object for the given bundle and locale.
- * If null is passed for the locale parameter, the default locale is used.
+ * If <code>null</code> is passed for the locale parameter, the default locale is used.
*/
-
public ResourceBundle getLocalization(Bundle bundle, String locale);
}
diff --git a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java
index f38b9c5f4..6aa16c032 100644
--- a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java
+++ b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
+ * Copyright (c) 2004, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,34 +10,61 @@
*******************************************************************************/
package org.eclipse.osgi.service.pluginconversion;
-
/**
* Custom exception for errors that can happen during plugin conversion.
+ *
+ * @since 3.0
*/
public class PluginConversionException extends Exception {
private static final long serialVersionUID = 3258130258472284472L;
+
/**
* Nested exception.
*/
private transient Throwable cause;
+ /**
+ * Constructor for the class.
+ */
public PluginConversionException() {
super();
}
+ /**
+ * Create a new exception with the given message.
+ *
+ * @param message the message for the exception
+ */
public PluginConversionException(String message) {
super(message);
}
+ /**
+ * Create a new exception with the given message and nested exception.
+ *
+ * @param message the message for the exception
+ * @param cause the nested exception
+ */
public PluginConversionException(String message, Throwable cause) {
super(message);
this.cause = cause;
}
+ /**
+ * Create a new exception with the given nested exception.
+ *
+ * @param cause the nested exception
+ */
public PluginConversionException(Throwable cause) {
this.cause = cause;
}
+ /**
+ * Return the nested exception for this exception or <code>null</code>
+ * if there is none.
+ *
+ * @return the nested exception or <code>null</code>
+ */
public Throwable getCause() {
return cause;
}
diff --git a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java
index eae288f1f..45d30abfb 100644
--- a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java
+++ b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
+ * Copyright (c) 2004, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -11,18 +11,20 @@
package org.eclipse.osgi.service.runnable;
/**
- * Like a java.lang.Runnable, an object which captures a block of code which can
+ * Like a {@link java.lang.Runnable}, an object which captures a block of code which can
* be passed around and executed. Unlike standard runnables, paramaterized
- * runnables allow an arbitrary <code>Object</code> to be passed in when the
+ * runnables allow an arbitrary {@link java.lang.Object} to be passed in when the
* block is evaluated.
- *
+ * <p>
+ * Clients may implement this interface.
+ * </p>
* @since 3.0
*/
public interface ParameterizedRunnable {
/**
* Executes the block of code encapsulated by this runnable in the context of
- * the given object and returns result. The result may be <code>null</code>.
+ * the given object and returns the result. The result may be <code>null</code>.
*
* @param context the context for evaluating the runnable
* @return the result of evaluating the runnable in the given context
diff --git a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/urlconversion/URLConverter.java b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/urlconversion/URLConverter.java
index 930ccae6f..a7407985c 100644
--- a/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/urlconversion/URLConverter.java
+++ b/bundles/org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/osgi/service/urlconversion/URLConverter.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
+ * Copyright (c) 2004, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -16,15 +16,20 @@ import java.net.URL;
/**
* The interface of the service that allows bundleresource or bundleentry
* URLs to be converted to native file URLs on the local file system.
+ * <p>
+ * This interface is not intended to be implemented by clients.
+ * </p>
+ * @since 3.1
*/
public interface URLConverter {
/**
* Converts a URL that uses a protocol of bundleentry or bundleresource into
* a URL that uses the file protocol. The contents of the URL may be extracted
* into a cache on the file system in order to get a file URL.
+ *
* @param url The bundleentry or bundleresource URL to convert into a file URL.
* @return The converted file URL or the original URL passed in if it is not
- * a bundleentry or bundleresource URL.
+ * a bundleentry or bundleresource URL.
* @throws IOException if an error occurs during the conversion.
*/
public URL convertToFileURL(URL url) throws IOException;
@@ -32,9 +37,10 @@ public interface URLConverter {
/**
* Converts a URL that uses a protocol of bundleentry or bundleresource into
* a URL that uses a local java protocol (file, jar etc).
+ *
* @param url The bundleentry or bundleresource URL to convert into a local URL.
* @return The converted file URL or the original URL passed in if it is not
- * a bundleentry or bundleresource URL.
+ * a bundleentry or bundleresource URL.
* @throws IOException if an error occurs during the conversion.
*/
public URL convertToLocalURL(URL url) throws IOException;
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java
index 65748e5dd..7e4fa4586 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
+ * Copyright (c) 2004, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -14,18 +14,21 @@ import java.util.ResourceBundle;
import org.osgi.framework.Bundle;
/**
- * The interface of the service that gets ResourceBundle objects from a given
+ * The interface of the service that gets {@link ResourceBundle} objects from a given
* bundle with a given locale.
+ * <p>
+ * This interface is not intended to be implemented by clients.
+ * </p>
+ * @since 3.1
*/
public interface BundleLocalization {
+
/**
* The getLocalization method gets a ResourceBundle object for the given
* locale and bundle.
*
- *
* @return A <code>ResourceBundle</code> object for the given bundle and locale.
- * If null is passed for the locale parameter, the default locale is used.
+ * If <code>null</code> is passed for the locale parameter, the default locale is used.
*/
-
public ResourceBundle getLocalization(Bundle bundle, String locale);
}
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java
index 930ccae6f..a7407985c 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
+ * Copyright (c) 2004, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -16,15 +16,20 @@ import java.net.URL;
/**
* The interface of the service that allows bundleresource or bundleentry
* URLs to be converted to native file URLs on the local file system.
+ * <p>
+ * This interface is not intended to be implemented by clients.
+ * </p>
+ * @since 3.1
*/
public interface URLConverter {
/**
* Converts a URL that uses a protocol of bundleentry or bundleresource into
* a URL that uses the file protocol. The contents of the URL may be extracted
* into a cache on the file system in order to get a file URL.
+ *
* @param url The bundleentry or bundleresource URL to convert into a file URL.
* @return The converted file URL or the original URL passed in if it is not
- * a bundleentry or bundleresource URL.
+ * a bundleentry or bundleresource URL.
* @throws IOException if an error occurs during the conversion.
*/
public URL convertToFileURL(URL url) throws IOException;
@@ -32,9 +37,10 @@ public interface URLConverter {
/**
* Converts a URL that uses a protocol of bundleentry or bundleresource into
* a URL that uses a local java protocol (file, jar etc).
+ *
* @param url The bundleentry or bundleresource URL to convert into a local URL.
* @return The converted file URL or the original URL passed in if it is not
- * a bundleentry or bundleresource URL.
+ * a bundleentry or bundleresource URL.
* @throws IOException if an error occurs during the conversion.
*/
public URL convertToLocalURL(URL url) throws IOException;

Back to the top