Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java')
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java70
1 files changed, 35 insertions, 35 deletions
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java
index 2ff4026bf..46d10ca33 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java
@@ -19,29 +19,29 @@ import java.util.Map;
/**
* Used to get debug options settings and creating a new {@link DebugTrace} instance for
* a bundle to use for dynamic tracing.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.
* @since 3.1
*/
public interface DebugOptions {
/**
- * The service property (named "listener.symbolic.name") which specifies
+ * The service property (named "listener.symbolic.name") which specifies
* the bundle symbolic name of a {@link DebugOptionsListener} service.
- *
+ *
* @since 3.5
*/
public static String LISTENER_SYMBOLICNAME = "listener.symbolic.name"; //$NON-NLS-1$
/**
* Returns the identified option as a boolean value. The specified
- * defaultValue is returned if no such option is found or if debug is not enabled.
- *
+ * defaultValue is returned if no such option is found or if debug is not enabled.
+ *
* <p>
- * Options are specified in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
+ * Options are specified in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
* For example, <code>org.eclipse.core.runtime/debug</code>
* </p>
- *
+ *
* @param option the name of the option to lookup
* @param defaultValue the value to return if no such option is found
* @return the value of the requested debug option or the
@@ -52,28 +52,28 @@ public interface DebugOptions {
/**
* Returns the identified option. A <code>null</code> value
* is returned if no such option is found or if debug is not enabled.
- *
+ *
* <p>
* Options are specified
- * in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
+ * in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
* For example, <code>org.eclipse.core.runtime/debug</code>
*</p>
- *
+ *
* @param option the name of the option to lookup
* @return the value of the requested debug option or <code>null</code>
*/
public abstract String getOption(String option);
/**
- * Returns the identified option. The specified defaultValue is
+ * Returns the identified option. The specified defaultValue is
* returned if no such option is found or if debug is not enabled.
- *
+ *
* <p>
* Options are specified
- * in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
+ * in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
* For example, <code>org.eclipse.core.runtime/debug</code>
* </p>
- *
+ *
* @param option the name of the option to lookup
* @param defaultValue the value to return if no such option is found
* @return the value of the requested debug option or the
@@ -83,16 +83,16 @@ public interface DebugOptions {
/**
* Returns the identified option as an int value. The specified
- * defaultValue is returned if no such option is found or if a
- * NumberFormatException is thrown while converting the option value
+ * defaultValue is returned if no such option is found or if a
+ * NumberFormatException is thrown while converting the option value
* to an integer or if debug is not enabled.
- *
+ *
* <p>
* Options are specified
- * in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
+ * in the general form <i>&lt;Bundle-SymbolicName&gt;/&lt;option-path&gt;</i>.
* For example, <code>org.eclipse.core.runtime/debug</code>
* </p>
- *
+ *
* @param option the name of the option to lookup
* @param defaultValue the value to return if no such option is found
* @return the value of the requested debug option or the
@@ -101,11 +101,11 @@ public interface DebugOptions {
public abstract int getIntegerOption(String option, int defaultValue);
/**
- * Returns a snapshot of the current options. All
+ * Returns a snapshot of the current options. All
* keys and values are of type <code>String</code>. If no
* options are set then an empty map is returned.
* <p>
- * If debug is not enabled then the snapshot of the current disabled
+ * If debug is not enabled then the snapshot of the current disabled
* values is returned. See {@link DebugOptions#setDebugEnabled(boolean)}.
* </p>
* @return a snapshot of the current options.
@@ -114,7 +114,7 @@ public interface DebugOptions {
public Map<String, String> getOptions();
/**
- * Sets the identified option to the identified value. If debug is
+ * Sets the identified option to the identified value. If debug is
* not enabled then the specified option is not changed.
* @param option the name of the option to set
* @param value the value of the option to set
@@ -124,13 +124,13 @@ public interface DebugOptions {
/**
* Sets the current option key/value pairs to the specified options.
* The specified map replaces all keys and values of the current debug options.
- * An <code>IllegalArgumentException</code> is thrown if any key or value
+ * An <code>IllegalArgumentException</code> is thrown if any key or value
* in the specified map is not of type <code>String</code>.
* <p>
* If debug is not enabled then the specified options are saved as
- * the disabled values and no notifications will be sent.
+ * the disabled values and no notifications will be sent.
* See {@link DebugOptions#setDebugEnabled(boolean)}.
- * If debug is enabled then notifications will be sent to the
+ * If debug is enabled then notifications will be sent to the
* listeners which have options that have been changed, added or removed.
* </p>
@@ -160,8 +160,8 @@ public interface DebugOptions {
* When debug is disabled all debug options are unset.
* When disabling debug the current debug option values are
* stored in memory as disabled values. If debug is re-enabled the
- * disabled values will be set back and enabled. The disabled values
- * are only stored in memory and if the framework is restarted then
+ * disabled values will be set back and enabled. The disabled values
+ * are only stored in memory and if the framework is restarted then
* the disabled option values will be lost.
* </p>
* @param value If <code>true</code>, debug is enabled, otherwise
@@ -170,12 +170,12 @@ public interface DebugOptions {
*/
public abstract void setDebugEnabled(boolean value);
- /**
+ /**
* Sets the current file used to trace messages to.
* A <code>null</code> value is allowed which indicates
* that <code>System.out</code> will be used
* for trace messages.
- *
+ *
* @param newFile The file to be used for tracing messages.
* A <code>null</code> value is allowed.
* @since 3.5
@@ -186,7 +186,7 @@ public interface DebugOptions {
* Returns the trace file if it is set, otherwise <code>null</code> is returned.
* A <code>null</code> value indicates that <code>System.out</code> is used
* for trace messages.
- *
+ *
* @return the trace file if it is set, otherwise <code>null</code> is returned.
* @since 3.5
*/
@@ -196,13 +196,13 @@ public interface DebugOptions {
* Creates a new <code>DebugTrace</code> instance for the specified bundle symbolic name.
* If a <code>DebugTrace</code> object has already been created for the specified symbolic
* name then the existing <code>DebugTrace</code> object will be returned.
- *
+ *
* The class name, method name, and line number of any callers to the <code>DebugTrace</code>
* API will automatically be determined by parsing the stack trace of the executing thread.
- * These attributes will be set based on the first caller of this API.
- *
+ * These attributes will be set based on the first caller of this API.
+ *
* @param bundleSymbolicName The symbolic name of the bundle that is requesting a
- * new instance of a <code>DebugTrace</code>.
+ * new instance of a <code>DebugTrace</code>.
* @return A new or existing <code>DebugTrace</code> object for the specified plug-in ID
* @since 3.5
*/
@@ -220,7 +220,7 @@ public interface DebugOptions {
*
* @param bundleSymbolicName The symbolic name of the bundle that is requesting a
* new instance of a <code>DebugTrace</code>.
- * @param traceEntryClass The class that is being used to abstract tracing calls for a bundle.
+ * @param traceEntryClass The class that is being used to abstract tracing calls for a bundle.
* @return A new or existing <code>DebugTrace</code> object for the specified plug-in ID
* @since 3.5
*/

Back to the top