Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright (c) 2003, 2010 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 http://www.eclipse.org/legal/epl-v10.html Contributors: IBM Corporation - initial API and implementation /
 
 package org.eclipse.osgi.service.debug;
 
 import java.io.File;
 import java.util.Map;

Used to get debug options settings and creating a new DebugTrace instance for a bundle to use for dynamic tracing.

Since:
3.1
Noimplement:
This interface is not intended to be implemented by clients.
Noextend:
This interface is not intended to be extended by clients.
 
 public interface DebugOptions {
The service property (named "listener.symbolic.name") which specifies the bundle symbolic name of a 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.

Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Parameters:
option the name of the option to lookup
defaultValue the value to return if no such option is found
Returns:
the value of the requested debug option or the defaultValue if no such option is found.
 
 	public abstract boolean getBooleanOption(String optionboolean defaultValue);

Returns the identified option. A null value is returned if no such option is found or if debug is not enabled.

Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Parameters:
option the name of the option to lookup
Returns:
the value of the requested debug option or null
 
 	public abstract String getOption(String option);

Returns the identified option. The specified defaultValue is returned if no such option is found or if debug is not enabled.

Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Parameters:
option the name of the option to lookup
defaultValue the value to return if no such option is found
Returns:
the value of the requested debug option or the defaultValue if no such option is found.
 
 	public abstract String getOption(String optionString defaultValue);

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 to an integer or if debug is not enabled.

Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Parameters:
option the name of the option to lookup
defaultValue the value to return if no such option is found
Returns:
the value of the requested debug option or the defaultValue if no such option is found.
 
 	public abstract int getIntegerOption(String optionint defaultValue);

Returns a snapshot of the current options. All keys and values are of type String. If no options are set then an empty map is returned.

If debug is not enabled then the snapshot of the current disabled values is returned. See setDebugEnabled(boolean).

Returns:
a snapshot of the current options.
Since:
3.6
	public Map /*<String, String>*/getOptions();

Sets the identified option to the identified value. If debug is not enabled then the specified option is not changed.

Parameters:
option the name of the option to set
value the value of the option to set
	public abstract void setOption(String optionString value);

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 IllegalArgumentException is thrown if any key or value in the specified map is not of type String.

If debug is not enabled then the specified options are saved as the disabled values and no notifications will be sent. See setDebugEnabled(boolean). If debug is enabled then notifications will be sent to the listeners which have options that have been changed, added or removed.

Parameters:
options the new set of options
Since:
3.6
	public abstract void setOptions(Map /*<String, String>*/options);

Removes the identified option. If debug is not enabled then the specified option is not removed.

Parameters:
option the name of the option to remove
Since:
3.5
	public abstract void removeOption(String option);

Returns true if debugging/tracing is currently enabled.

Returns:
true if debugging/tracing is currently enabled; Otherwise false is returned.
Since:
3.5
	public abstract boolean isDebugEnabled();

Enables or disables debugging/tracing.

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 the disabled option values will be lost.

Parameters:
value If true, debug is enabled, otherwise debug is disabled.
Since:
3.5
	public abstract void setDebugEnabled(boolean value);

Sets the current file used to trace messages to.

Parameters:
newFile The file to be used for tracing messages.
Since:
3.5
	public abstract void setFile(File newFile);

Returns the trace file if it is set, otherwise null is returned.

Returns:
the trace file if it is set, otherwise null is returned.
Since:
3.5
	public abstract File getFile();

Creates a new DebugTrace instance for the specified bundle symbolic name. If a DebugTrace object has already been created for the specified symbolic name then the existing DebugTrace object will be returned. The class name, method name, and line number of any callers to the DebugTrace 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.

Parameters:
bundleSymbolicName The symbolic name of the bundle that is requesting a new instance of a DebugTrace.
Returns:
A new or existing DebugTrace object for the specified plug-in ID
Since:
3.5
	public abstract DebugTrace newDebugTrace(String bundleSymbolicName);

Create a new DebugTrace instance for the specified bundle symbolic name. If a DebugTrace object has already been created for the specified symbolic name then the existing DebugTrace object will be returned. The class name, method name, and line number of any callers to the DebugTrace API will automatically be determined by parsing the stack trace of the executing thread. The values of these attributes will be based on the last invocation to the specified traceEntryClass found in the parsed stack trace.

Parameters:
bundleSymbolicName The symbolic name of the bundle that is requesting a new instance of a DebugTrace.
traceEntryClass The class that is being used to abstract tracing calls for a bundle.
Returns:
A new or existing DebugTrace object for the specified plug-in ID
Since:
3.5
	public abstract DebugTrace newDebugTrace(String bundleSymbolicNameClass traceEntryClass);
New to GrepCode? Check out our FAQ X