Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Watson2014-02-19 14:55:25 +0000
committerThomas Watson2014-02-19 14:55:25 +0000
commitce832d6acbf8eb59a6cf6d27c7306b0e05704d89 (patch)
tree554f65012ff9c27e54ad2a5891c38cc6eb0ab034 /bundles/org.eclipse.osgi/supplement/src
parent2518e596b4e5dbbdd8d623c56dd60db5f6083b09 (diff)
downloadrt.equinox.framework-ce832d6acbf8eb59a6cf6d27c7306b0e05704d89.tar.gz
rt.equinox.framework-ce832d6acbf8eb59a6cf6d27c7306b0e05704d89.tar.xz
rt.equinox.framework-ce832d6acbf8eb59a6cf6d27c7306b0e05704d89.zip
Bug 428439 - Update API javadoc to ensure that when null is passed as traceFile, output is done on standard output stream
Diffstat (limited to 'bundles/org.eclipse.osgi/supplement/src')
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java8
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java4
2 files changed, 9 insertions, 3 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 9f9bc254f..0c97c0a08 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
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2003, 2010 IBM Corporation and others.
+ * Copyright (c) 2003, 2014 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
@@ -169,14 +169,20 @@ public interface DebugOptions {
/**
* 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
*/
public abstract void setFile(File newFile);
/**
* 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
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java
index a6768b731..70aafe2cb 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2009, 2010 IBM Corporation and others.
+ * Copyright (c) 2009, 2014 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
@@ -17,7 +17,7 @@ package org.eclipse.osgi.service.debug;
* and method performing the tracing.
* <p>
* Trace statements may be written to a file, or onto standard output, depending on
- * how the {@link DebugOptions} is configured.
+ * how the {@link DebugOptions} is configured (See {@link DebugOptions#setFile(java.io.File)}).
* </p>
* <p>
* All methods on this class have an optional <code>option</code> argument.

Back to the top