org.eclipse.core.runtime.internal.adaptor

Class EclipseEnvironmentInfo

java.lang.Object

org.eclipse.core.runtime.internal.adaptor.EclipseEnvironmentInfo

All Implemented Interfaces:

EnvironmentInfo

public class EclipseEnvironmentInfo
extends Object
implements EnvironmentInfo

Internal class.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getCommandLineArgs() Returns all command line arguments specified when the running framework was started.
static EclipseEnvironmentInfo	getDefault()
String[]	getFrameworkArgs() Returns the arguments consumed by the framework implementation itself.
String	getNL() Returns the string name of the current locale for use in finding files whose path starts with $nl$.
String[]	getNonFrameworkArgs() Returns the arguments not consumed by the framework implementation itself.
String	getOS() Returns the string name of the current operating system for use in finding files whose path starts with $os$.
String	getOSArch() Returns the string name of the current system architecture.
String	getProperty(String key) Returns the value for the specified property.
String	getWS() Returns the string name of the current window system for use in finding files whose path starts with $ws$.
static String	guessOS(String osName)
static String	guessWS(String osName)
boolean	inDebugMode() Returns true if the framework is in debug mode and false otherwise.
boolean	inDevelopmentMode() Returns true if the framework is in development mode and false otherwise.
static void	setAllArgs(String[] allArgs)
static void	setAppArgs(String[] appArgs)
static void	setFrameworkArgs(String[] frameworkArgs)
String	setProperty(String key, String value) Sets the value for the specified property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefault

public static EclipseEnvironmentInfo getDefault()

inDevelopmentMode

public boolean inDevelopmentMode()

Description copied from interface: EnvironmentInfo

Returns true if the framework is in development mode and false otherwise.

Specified by:

inDevelopmentMode in interface EnvironmentInfo

Returns:

whether or not the framework is in development mode

inDebugMode

public boolean inDebugMode()

Description copied from interface: EnvironmentInfo

Returns true if the framework is in debug mode and false otherwise.

Specified by:

inDebugMode in interface EnvironmentInfo

Returns:

whether or not the framework is in debug mode

getCommandLineArgs

public String[] getCommandLineArgs()

Description copied from interface: EnvironmentInfo

Returns all command line arguments specified when the running framework was started.

Specified by:

getCommandLineArgs in interface EnvironmentInfo

Returns:

the array of command line arguments.

getFrameworkArgs

public String[] getFrameworkArgs()

Description copied from interface: EnvironmentInfo

Returns the arguments consumed by the framework implementation itself. Which arguments are consumed is implementation specific.

Specified by:

getFrameworkArgs in interface EnvironmentInfo

Returns:

the array of command line arguments consumed by the framework.

getNonFrameworkArgs

public String[] getNonFrameworkArgs()

Description copied from interface: EnvironmentInfo

Returns the arguments not consumed by the framework implementation itself. Which arguments are consumed is implementation specific.

Specified by:

getNonFrameworkArgs in interface EnvironmentInfo

Returns:

the array of command line arguments not consumed by the framework.

getOSArch

public String getOSArch()

Description copied from interface: EnvironmentInfo

Returns the string name of the current system architecture. The value is a user-defined string if the architecture is specified on the command line, otherwise it is the value returned by java.lang.System.getProperty("os.arch").

Specified by:

getOSArch in interface EnvironmentInfo

Returns:

the string name of the current system architecture

getNL

public String getNL()

Description copied from interface: EnvironmentInfo

Returns the string name of the current locale for use in finding files whose path starts with $nl$.

Specified by:

getNL in interface EnvironmentInfo

Returns:

the string name of the current locale

getOS

public String getOS()

Description copied from interface: EnvironmentInfo

Returns the string name of the current operating system for use in finding files whose path starts with $os$. Return Constants.OS_UNKNOWN if the operating system cannot be determined.

The value may indicate one of the operating systems known to the platform (as specified in org.eclipse.core.runtime.Platform#knownOSValues) or a user-defined string if the operating system name is specified on the command line.

Specified by:

getOS in interface EnvironmentInfo

Returns:

the string name of the current operating system

getWS

public String getWS()

Description copied from interface: EnvironmentInfo

Returns the string name of the current window system for use in finding files whose path starts with $ws$. Return null if the window system cannot be determined.

Specified by:

getWS in interface EnvironmentInfo

Returns:

the string name of the current window system or null

setAllArgs

public static void setAllArgs(String[] allArgs)

setAppArgs

public static void setAppArgs(String[] appArgs)

setFrameworkArgs

public static void setFrameworkArgs(String[] frameworkArgs)

guessWS

public static String guessWS(String osName)

guessOS

public static String guessOS(String osName)

getProperty

public String getProperty(String key)

Description copied from interface: EnvironmentInfo

Returns the value for the specified property. Environment Properties are backed by the Java system properties. When the option osgi.framework.useSystemProperties is used then the environment properties are specific for each instance of the framework.

This method should be used instead of the System.getProperty(String) method to avoid the global nature of system properties.

Specified by:

getProperty in interface EnvironmentInfo

Parameters:

key - the property key

Returns:

the value of the property, or null

setProperty

public String setProperty(String key,
                 String value)

Description copied from interface: EnvironmentInfo

Sets the value for the specified property. Environment Properties are backed by the Java system properties. When the option osgi.framework.useSystemProperties is used then the environment properties are specific for each instance of the framework.

This method should be used instead of the System.setProperty(String, String) method to avoid the global nature of system properties.

Specified by:

setProperty in interface EnvironmentInfo

Parameters:

key - the property key

value - the value of the property

Returns:

the old value of the property, or null