org.eclipse.osgi.service.debug
Interface DebugOptions

All Known Implementing Classes:
FrameworkDebugOptions

public interface DebugOptions

Used to get debug options settings.

This interface is not intended to be implemented by clients.

Since:
3.1

Method Summary
 boolean getBooleanOption(java.lang.String option, boolean defaultValue)
          Returns the identified option as a boolean value.
 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.
 

Method Detail

getBooleanOption

boolean getBooleanOption(java.lang.String option,
                         boolean defaultValue)
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

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.

getOption

java.lang.String getOption(java.lang.String option)
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

Parameters:
option - the name of the option to lookup
Returns:
the value of the requested debug option or null

getOption

java.lang.String getOption(java.lang.String option,
                           java.lang.String defaultValue)
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

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.

getIntegerOption

int getIntegerOption(java.lang.String option,
                     int defaultValue)
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

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.

setOption

void setOption(java.lang.String option,
               java.lang.String value)
Sets the identified option to the identified value.

Parameters:
option - the name of the option to set
value - the value of the option to set