org.eclipse.osgi.framework.debug
Class FrameworkDebugOptions

java.lang.Object
  extended by org.eclipse.osgi.framework.debug.FrameworkDebugOptions
All Implemented Interfaces:
DebugOptions

public class FrameworkDebugOptions
extends java.lang.Object
implements DebugOptions

The DebugOptions class used by the framework to get debug options from.

Since:
3.1

Method Summary
 boolean getBooleanOption(java.lang.String option, boolean defaultValue)
          Returns the identified option as a boolean value.
static FrameworkDebugOptions getDefault()
          Returns the singleton instance of FrameworkDebugOptions.
 int getIntegerOption(java.lang.String option, int defaultValue)
          Returns the identified option as an int value.
 java.lang.String getOption(java.lang.String option)
          Returns the identified option.
 java.lang.String getOption(java.lang.String option, java.lang.String defaultValue)
          Returns the identified option.
 void setOption(java.lang.String option, java.lang.String value)
          Sets the identified option to the identified value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDefault

public static FrameworkDebugOptions getDefault()
Returns the singleton instance of FrameworkDebugOptions. If debug is not enabled then null is returned.

Returns:
the instance of FrameworkDebugOptions

getBooleanOption

public boolean getBooleanOption(java.lang.String option,
                                boolean defaultValue)
Description copied from interface: DebugOptions
Returns the identified option as a boolean value. The specified defaultValue is returned if no such option is found. Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Specified by:
getBooleanOption in interface DebugOptions
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.
See Also:
DebugOptions.getBooleanOption(String, boolean)

getOption

public java.lang.String getOption(java.lang.String option)
Description copied from interface: DebugOptions
Returns the identified option. null is returned if no such option is found. Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Specified by:
getOption in interface DebugOptions
Parameters:
option - the name of the option to lookup
Returns:
the value of the requested debug option or null
See Also:
DebugOptions.getOption(String)

getOption

public java.lang.String getOption(java.lang.String option,
                                  java.lang.String defaultValue)
Description copied from interface: DebugOptions
Returns the identified option. 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. Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Specified by:
getOption in interface DebugOptions
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.
See Also:
DebugOptions.getOption(String, String)

getIntegerOption

public int getIntegerOption(java.lang.String option,
                            int defaultValue)
Description copied from interface: DebugOptions
Returns the identified option as an int value. The specified defaultValue is returned if no such option is found. Options are specified in the general form <Bundle-SymbolicName>/<option-path>. For example, org.eclipse.core.runtime/debug

Specified by:
getIntegerOption in interface DebugOptions
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.
See Also:
DebugOptions.getIntegerOption(String, int)

setOption

public void setOption(java.lang.String option,
                      java.lang.String value)
Description copied from interface: DebugOptions
Sets the identified option to the identified value.

Specified by:
setOption in interface DebugOptions
Parameters:
option - the name of the option to set
value - the value of the option to set
See Also:
DebugOptions.setOption(String, String)