Class Platform


  • public final class Platform
    extends Object
    The central class of the Eclipse Platform Runtime. This class cannot be instantiated or subclassed by clients; all functionality is provided by static methods. Features include:
    • the platform registry of installed plug-ins
    • the platform adapter manager
    • the platform log
    • the authorization info management

    Most users don't have to worry about Platform's lifecycle. However, if your code can call methods of this class when Platform is not running, it becomes necessary to check isRunning() before making the call. A runtime exception might be thrown or incorrect result might be returned if a method from this class is called while Platform is not running.

    • Field Detail

      • PI_RUNTIME

        public static final String PI_RUNTIME
        The unique identifier constant (value "org.eclipse.core.runtime") of the Core Runtime (pseudo-) plug-in.
        See Also:
        Constant Field Values
      • PT_APPLICATIONS

        public static final String PT_APPLICATIONS
        The simple identifier constant (value "applications") of the extension point of the Core Runtime plug-in where plug-ins declare the existence of runnable applications. A plug-in may define any number of applications; however, the platform is only capable of running one application at a time.
        See Also:
        Constant Field Values
      • PT_ADAPTERS

        public static final String PT_ADAPTERS
        The simple identifier constant (value "adapters") of the extension point of the Core Runtime plug-in where plug-ins declare the existence of adapter factories. A plug-in may define any number of adapters.
        Since:
        3.0
        See Also:
        IAdapterManager.hasAdapter(Object, String), Constant Field Values
      • PT_PREFERENCES

        public static final String PT_PREFERENCES
        The simple identifier constant (value "preferences") of the extension point of the Core Runtime plug-in where plug-ins declare extensions to the preference facility. A plug-in may define any number of preference extensions.
        Since:
        3.0
        See Also:
        getPreferencesService(), Constant Field Values
      • PT_PRODUCT

        public static final String PT_PRODUCT
        The simple identifier constant (value "products") of the extension point of the Core Runtime plug-in where plug-ins declare the existence of a product. A plug-in may define any number of products; however, the platform is only capable of running one product at a time.
        Since:
        3.0
        See Also:
        getProduct(), Constant Field Values
      • OPTION_STARTTIME

        public static final String OPTION_STARTTIME
        Debug option value denoting the time at which the platform runtime was started. This constant can be used in conjunction with getDebugOption to find the string value of System.currentTimeMillis() when the platform was started.
        See Also:
        Constant Field Values
      • PREF_PLATFORM_PERFORMANCE

        public static final String PREF_PLATFORM_PERFORMANCE
        Name of a preference for configuring the performance level for this system.

        This value can be used by all components to customize features to suit the speed of the user's machine. The platform job manager uses this value to make scheduling decisions about background jobs.

        The preference value must be an integer between the constant values MIN_PERFORMANCE and MAX_PERFORMANCE

        Since:
        3.0
        See Also:
        MIN_PERFORMANCE, MAX_PERFORMANCE, Constant Field Values
      • MIN_PERFORMANCE

        public static final int MIN_PERFORMANCE
        Constant (value 1) indicating the minimum allowed value for the PREF_PLATFORM_PERFORMANCE preference setting.
        Since:
        3.0
        See Also:
        Constant Field Values
      • MAX_PERFORMANCE

        public static final int MAX_PERFORMANCE
        Constant (value 5) indicating the maximum allowed value for the PREF_PLATFORM_PERFORMANCE preference setting.
        Since:
        3.0
        See Also:
        Constant Field Values
      • PARSE_PROBLEM

        public static final int PARSE_PROBLEM
        Status code constant (value 1) indicating a problem in a plug-in manifest (plugin.xml) file.
        See Also:
        Constant Field Values
      • PLUGIN_ERROR

        public static final int PLUGIN_ERROR
        Status code constant (value 2) indicating an error occurred while running a plug-in.
        See Also:
        Constant Field Values
      • INTERNAL_ERROR

        public static final int INTERNAL_ERROR
        Status code constant (value 3) indicating an error internal to the platform has occurred.
        See Also:
        Constant Field Values
      • FAILED_READ_METADATA

        public static final int FAILED_READ_METADATA
        Status code constant (value 4) indicating the platform could not read some of its metadata.
        See Also:
        Constant Field Values
      • FAILED_WRITE_METADATA

        public static final int FAILED_WRITE_METADATA
        Status code constant (value 5) indicating the platform could not write some of its metadata.
        See Also:
        Constant Field Values
      • FAILED_DELETE_METADATA

        public static final int FAILED_DELETE_METADATA
        Status code constant (value 6) indicating the platform could not delete some of its metadata.
        See Also:
        Constant Field Values
      • OS_WIN32

        public static final String OS_WIN32
        Constant string (value "win32") indicating the platform is running on a Window 32-bit operating system (e.g., Windows 98, NT, 2000).

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • OS_LINUX

        public static final String OS_LINUX
        Constant string (value "linux") indicating the platform is running on a Linux-based operating system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • OS_AIX

        @Deprecated
        public static final String OS_AIX
        Deprecated.
        not supported anymore
        Constant string (value "aix") indicating the platform is running on an AIX-based operating system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • OS_SOLARIS

        @Deprecated
        public static final String OS_SOLARIS
        Deprecated.
        not supported anymore
        Constant string (value "solaris") indicating the platform is running on a Solaris-based operating system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • OS_HPUX

        @Deprecated
        public static final String OS_HPUX
        Deprecated.
        not supported anymore
        Constant string (value "hpux") indicating the platform is running on an HP/UX-based operating system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • OS_QNX

        @Deprecated
        public static final String OS_QNX
        Deprecated.
        not supported anymore
        Constant string (value "qnx") indicating the platform is running on a QNX-based operating system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • OS_MACOSX

        public static final String OS_MACOSX
        Constant string (value "macosx") indicating the platform is running on a Mac OS X operating system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • OS_UNKNOWN

        public static final String OS_UNKNOWN
        Constant string (value "unknown") indicating the platform is running on a machine running an unknown operating system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • ARCH_X86

        public static final String ARCH_X86
        Constant string (value "x86") indicating the platform is running on an x86-based architecture.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • ARCH_PA_RISC

        @Deprecated
        public static final String ARCH_PA_RISC
        Deprecated.
        not supported anymore
        Constant string (value "PA_RISC") indicating the platform is running on an PA_RISC-based architecture.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • ARCH_PPC

        @Deprecated
        public static final String ARCH_PPC
        Deprecated.
        not supported anymore
        Constant string (value "ppc") indicating the platform is running on an PowerPC-based architecture.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • ARCH_SPARC

        @Deprecated
        public static final String ARCH_SPARC
        Deprecated.
        not supported anymore
        Constant string (value "sparc") indicating the platform is running on an Sparc-based architecture.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • ARCH_X86_64

        public static final String ARCH_X86_64
        Constant string (value "x86_64") indicating the platform is running on an x86 64bit-based architecture.
        Since:
        3.1
        See Also:
        Constant Field Values
      • ARCH_AMD64

        @Deprecated
        public static final String ARCH_AMD64
        Deprecated.
        use ARCH_X86_64 instead. Note the values has been changed to be the value of the ARCH_X86_64 constant.
        Constant string (value "amd64") indicating the platform is running on an AMD64-based architecture.
        Since:
        3.0
        See Also:
        Constant Field Values
      • ARCH_IA64

        @Deprecated
        public static final String ARCH_IA64
        Deprecated.
        not supported anymore
        Constant string (value "ia64") indicating the platform is running on an IA64-based architecture.
        Since:
        3.0
        See Also:
        Constant Field Values
      • ARCH_IA64_32

        @Deprecated
        public static final String ARCH_IA64_32
        Deprecated.
        not supported anymore
        Constant string (value "ia64_32") indicating the platform is running on an IA64 32bit-based architecture.
        Since:
        3.1
        See Also:
        Constant Field Values
      • WS_WIN32

        public static final String WS_WIN32
        Constant string (value "win32") indicating the platform is running on a machine using the Windows windowing system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • WS_MOTIF

        @Deprecated
        public static final String WS_MOTIF
        Deprecated.
        not supported anymore
        Constant string (value "motif") indicating the platform is running on a machine using the Motif windowing system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • WS_GTK

        public static final String WS_GTK
        Constant string (value "gtk") indicating the platform is running on a machine using the GTK windowing system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • WS_PHOTON

        @Deprecated
        public static final String WS_PHOTON
        Deprecated.
        not supported anymore
        Constant string (value "photon") indicating the platform is running on a machine using the Photon windowing system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • WS_CARBON

        @Deprecated
        public static final String WS_CARBON
        Deprecated.
        not supported anymore
        Constant string (value "carbon") indicating the platform is running on a machine using the Carbon windowing system (Mac OS X).

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
      • WS_COCOA

        public static final String WS_COCOA
        Constant string (value "cocoa") indicating the platform is running on a machine using the Cocoa windowing system (Mac OS X).
        Since:
        3.5
        See Also:
        Constant Field Values
      • WS_WPF

        public static final String WS_WPF
        Constant string (value "wpf") indicating the platform is running on a machine using the WPF windowing system.
        Since:
        3.3
        See Also:
        Constant Field Values
      • WS_UNKNOWN

        public static final String WS_UNKNOWN
        Constant string (value "unknown") indicating the platform is running on a machine running an unknown windowing system.

        Note this constant has been moved from the deprecated org.eclipse.core.boot.BootLoader class and its value has not changed.

        Since:
        3.0
        See Also:
        Constant Field Values
    • Method Detail

      • addAuthorizationInfo

        @Deprecated
        public static void addAuthorizationInfo​(URL serverUrl,
                                                String realm,
                                                String authScheme,
                                                Map<String,​String> info)
                                         throws CoreException
        Deprecated.
        Authorization database is superseded by the Equinox secure storage. Use org.eclipse.equinox.security.storage.SecurePreferencesFactory to obtain secure preferences and org.eclipse.equinox.security.storage.ISecurePreferences for data access and modifications. Consider using ISecurePreferences#put(String, String, boolean) as a replacement of this method. This API will be deleted in a future release. See bug 370248 for details.
        Adds the given authorization information to the key ring. The information is relevant for the specified protection space and the given authorization scheme. The protection space is defined by the combination of the given server URL and realm. The authorization scheme determines what the authorization information contains and how it should be used. The authorization information is a Map of String to String and typically contains information such as user names and passwords.
        Parameters:
        serverUrl - the URL identifying the server for this authorization information. For example, "http://www.example.com/".
        realm - the subsection of the given server to which this authorization information applies. For example, "realm1@example.com" or "" for no realm.
        authScheme - the scheme for which this authorization information applies. For example, "Basic" or "" for no authorization scheme
        info - a Map containing authorization information such as user names and passwords (key type : String, value type : String)
        Throws:
        CoreException - if there are problems setting the authorization information. Reasons include:
        • The keyring could not be saved.
      • addLogListener

        public static void addLogListener​(ILogListener listener)
        Adds the given log listener to the notification list of the platform.

        Once registered, a listener starts receiving notification as entries are added to plug-in logs via ILog.log(). The listener continues to receive notifications until it is replaced or removed.

        Parameters:
        listener - the listener to register
        See Also:
        ILog.addLogListener(ILogListener), removeLogListener(ILogListener)
      • addProtectionSpace

        @Deprecated
        public static void addProtectionSpace​(URL resourceUrl,
                                              String realm)
                                       throws CoreException
        Deprecated.
        Authorization database is superseded by the Equinox secure storage. Use org.eclipse.equinox.security.storage.SecurePreferencesFactory to obtain secure preferences and org.eclipse.equinox.security.storage.ISecurePreferences for data access and modifications. This API will be deleted in a future release. See bug 370248 for details.
        Adds the specified resource to the protection space specified by the given realm. All targets at or deeper than the depth of the last symbolic element in the path of the given resource URL are assumed to be in the same protection space.
        Parameters:
        resourceUrl - the URL identifying the resources to be added to the specified protection space. For example, "http://www.example.com/folder/".
        realm - the name of the protection space. For example, "realm1@example.com"
        Throws:
        CoreException - if there are problems setting the authorization information. Reasons include:
        • The key ring could not be saved.
      • asLocalURL

        @Deprecated
        public static URL asLocalURL​(URL url)
                              throws IOException
        Deprecated.
        Returns a URL that is the local equivalent of the supplied URL. This method is expected to be used with the plug-in-relative URLs returned by IPluginDescriptor, Bundle.getEntry() and Platform.find(). If the specified URL is not a plug-in-relative URL, it is returned as is. If the specified URL is a plug-in-relative URL of a file (including .jar archive), it is returned as a locally accessible URL using "file:" protocol (extracting/caching the file locally, if required). If the specified URL is a plug-in-relative URL of a directory, the directory and any files and directories under it are made locally accessible likewise.
        Parameters:
        url - original plug-in-relative URL.
        Returns:
        the resolved URL
        Throws:
        IOException - if unable to resolve URL
        See Also:
        resolve(URL), find(Bundle, IPath), Bundle.getEntry(String)
      • flushAuthorizationInfo

        @Deprecated
        public static void flushAuthorizationInfo​(URL serverUrl,
                                                  String realm,
                                                  String authScheme)
                                           throws CoreException
        Deprecated.
        Authorization database is superseded by the Equinox secure storage. Use org.eclipse.equinox.security.storage.SecurePreferencesFactory to obtain secure preferences and org.eclipse.equinox.security.storage.ISecurePreferences for data access and modifications. Consider using ISecurePreferences#clear() as a replacement of this method. This API will be deleted in a future release. See bug 370248 for details.
        Removes the authorization information for the specified protection space and given authorization scheme. The protection space is defined by the given server URL and realm.
        Parameters:
        serverUrl - the URL identifying the server to remove the authorization information for. For example, "http://www.example.com/".
        realm - the subsection of the given server to remove the authorization information for. For example, "realm1@example.com" or "" for no realm.
        authScheme - the scheme for which the authorization information to remove applies. For example, "Basic" or "" for no authorization scheme.
        Throws:
        CoreException - if there are problems removing the authorization information. Reasons include:
        • The keyring could not be saved.
      • getAdapterManager

        public static IAdapterManager getAdapterManager()
        Returns the adapter manager used for extending IAdaptable objects.
        Returns:
        the adapter manager for this platform
        See Also:
        IAdapterManager
      • getAuthorizationInfo

        @Deprecated
        public static Map<String,​String> getAuthorizationInfo​(URL serverUrl,
                                                                    String realm,
                                                                    String authScheme)
        Deprecated.
        Authorization database is superseded by the Equinox secure storage. Use org.eclipse.equinox.security.storage.SecurePreferencesFactory to obtain secure preferences and org.eclipse.equinox.security.storage.ISecurePreferences for data access and modifications. Consider using ISecurePreferences#get(String, String) as a replacement of this method. This API will be deleted in a future release. See bug 370248 for details.
        Returns the authorization information for the specified protection space and given authorization scheme. The protection space is defined by the given server URL and realm. Returns null if no such information exists.
        Parameters:
        serverUrl - the URL identifying the server for the authorization information. For example, "http://www.example.com/".
        realm - the subsection of the given server to which the authorization information applies. For example, "realm1@example.com" or "" for no realm.
        authScheme - the scheme for which the authorization information applies. For example, "Basic" or "" for no authorization scheme
        Returns:
        the authorization information for the specified protection space and given authorization scheme, or null if no such information exists
      • getCommandLineArgs

        public static String[] getCommandLineArgs()
        Returns the command line args provided to the Eclipse runtime layer when it was first run. The returned value does not include arguments consumed by the lower levels of Eclipse (e.g., OSGi or the launcher). Note that individual platform runnables may be provided with different arguments if they are being run individually rather than with Platform.run().

        Clients are also able to acquire the EnvironmentInfo service and query it for the command-line arguments.

        Returns:
        the command line used to start the platform
      • getContentTypeManager

        public static IContentTypeManager getContentTypeManager()
        Returns the content type manager.

        Clients are also able to acquire the IContentTypeManager service.

        Returns:
        the content type manager
        Since:
        3.0
      • getDebugOption

        public static String getDebugOption​(String option)
        Returns the identified option. null is returned if no such option is found. Options are specified in the general form <plug-in id>/<option-path>. For example, org.eclipse.core.runtime/debug

        Clients are also able to acquire the DebugOptions service and query it for debug options.

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

        public static IPath getLocation()
                                 throws IllegalStateException
        Returns the location of the platform working directory.

        Callers of this method should consider using getInstanceLocation instead. In various, typically non IDE-related configurations of Eclipse, the platform working directory may not be on the local file system. As such, the more general form of this location is as a URL.

        Alternatively, instead of calling getInstanceLocation clients are able to acquire the Location service (with the type Location.INSTANCE_FILTER) and then change the resulting URL to a path. See the javadoc for getInstanceLocation for more details.

        Returns:
        the location of the platform
        Throws:
        IllegalStateException
        See Also:
        getInstanceLocation()
      • getLogFileLocation

        public static IPath getLogFileLocation()
        Returns the location of the platform log file. This file may contain information about errors that have previously occurred during this invocation of the Platform.

        It is recommended not to keep this value, as the log location may vary when an instance location is being set.

        Note: it is very important that users of this method do not leave the log file open for extended periods of time. Doing so may prevent others from writing to the log file, which could result in important error messages being lost. It is strongly recommended that clients wanting to read the log file for extended periods should copy the log file contents elsewhere, and immediately close the original file.

        Returns:
        the path of the log file on disk.
      • getPlugin

        @Deprecated
        public static Plugin getPlugin​(String id)
        Deprecated.
        As the org.eclipse.core.runtime.compatibility plug-in has been removed in Eclipse 4.6 this method is not supported anymore.
      • getPluginRegistry

        @Deprecated
        public static IPluginRegistry getPluginRegistry()
        Deprecated.
        As the org.eclipse.core.runtime.compatibility plug-in has been removed in Eclipse 4.6 this method is not supported anymore. See the comments on IPluginRegistry and its methods for details.
      • getPluginStateLocation

        @Deprecated
        public static IPath getPluginStateLocation​(Plugin plugin)
        Deprecated.
        clients should call getStateLocation(Bundle) instead
        Returns the location in the local file system of the plug-in state area for the given plug-in. The platform must be running.

        The plug-in state area is a file directory within the platform's metadata area where a plug-in is free to create files. The content and structure of this area is defined by the plug-in, and the particular plug-in is solely responsible for any files it puts there. It is recommended for plug-in preference settings.

        Parameters:
        plugin - the plug-in whose state location is returned
        Returns:
        a local file system path
      • getProtectionSpace

        @Deprecated
        public static String getProtectionSpace​(URL resourceUrl)
        Deprecated.
        Authorization database is superseded by the Equinox secure storage. Use org.eclipse.equinox.security.storage.SecurePreferencesFactory to obtain secure preferences and org.eclipse.equinox.security.storage.ISecurePreferences for data access and modifications. This API will be deleted in a future release. See bug 370248 for details.
        Returns the protection space (realm) for the specified resource, or null if the realm is unknown.
        Parameters:
        resourceUrl - the URL of the resource whose protection space is returned. For example, "http://www.example.com/folder/".
        Returns:
        the protection space (realm) for the specified resource, or null if the realm is unknown
      • resolve

        @Deprecated
        public static URL resolve​(URL url)
                           throws IOException
        Deprecated.
        Returns a URL which is the resolved equivalent of the supplied URL. This method is expected to be used with the plug-in-relative URLs returned by IPluginDescriptor, Bundle.getEntry() and Platform.find().

        If the specified URL is not a plug-in-relative URL, it is returned as is. If the specified URL is a plug-in-relative URL, this method attempts to reduce the given URL to one which is native to the Java class library (eg. file, http, etc).

        Note however that users of this API should not assume too much about the results of this method. While it may consistently return a file: URL in certain installation configurations, others may result in jar: or http: URLs.

        Parameters:
        url - original plug-in-relative URL.
        Returns:
        the resolved URL
        Throws:
        IOException - if unable to resolve URL
        See Also:
        asLocalURL(URL), find(Bundle, IPath), Bundle.getEntry(String)
      • run

        @Deprecated
        public static void run​(ISafeRunnable runnable)
        Deprecated.
        clients should use SafeRunner#run instead
        Runs the given runnable in a protected mode. Exceptions thrown in the runnable are logged and passed to the runnable's exception handler. Such exceptions are not rethrown by this method.
        Parameters:
        runnable - the runnable to run
      • getJobManager

        @Deprecated
        public static IJobManager getJobManager()
        Deprecated.
        The method Job.getJobManager() should be used instead.
        Returns the platform job manager.
        Returns:
        the platform's job manager
        Since:
        3.0
        Restriction:
        This method is planned for removal. See bug#528192 for details.
      • find

        @Deprecated
        public static URL find​(Bundle bundle,
                               IPath path,
                               Map<String,​String> override)
        Deprecated.
        Returns a URL for the given path in the given bundle. Returns null if the URL could not be computed or created.

        find looks for this path in given bundle and any attached fragments. null is returned if no such entry is found. Note that there is no specific order to the fragments.

        The following arguments may also be used:

             $nl$ - for language specific information
             $os$ - for operating system specific information
             $ws$ - for windowing system specific information
         

        A path of $nl$/about.properties in an environment with a default locale of en_CA will return a URL corresponding to the first place about.properties is found according to the following order:

             plugin root/nl/en/CA/about.properties
             fragment1 root/nl/en/CA/about.properties
             fragment2 root/nl/en/CA/about.properties
             ...
             plugin root/nl/en/about.properties
             fragment1 root/nl/en/about.properties
             fragment2 root/nl/en/about.properties
             ...
             plugin root/about.properties
             fragment1 root/about.properties
             fragment2 root/about.properties
             ...
         

        The current environment variable values can be overridden using the override map argument.

        Parameters:
        bundle - the bundle in which to search
        path - file path relative to plug-in installation location
        override - map of override substitution arguments to be used for any $arg$ path elements. The map keys correspond to the substitution arguments (eg. "$nl$" or "$os$"). The resulting values must be of type java.lang.String. If the map is null, or does not contain the required substitution argument, the default is used.
        Returns:
        a URL for the given path or null. The actual form of the returned URL is not specified.
        Since:
        3.0
        See Also:
        resolve(URL), asLocalURL(URL)
      • getStateLocation

        public static IPath getStateLocation​(Bundle bundle)
        Returns the location in the local file system of the plug-in state area for the given bundle. If the plug-in state area did not exist prior to this call, it is created.

        The plug-in state area is a file directory within the platform's metadata area where a plug-in is free to create files. The content and structure of this area is defined by the plug-in, and the particular plug-in is solely responsible for any files it puts there. It is recommended for plug-in preference settings and other configuration parameters.

        Parameters:
        bundle - the bundle whose state location if returned
        Returns:
        a local file system path
        Since:
        3.0
      • getStateStamp

        public static long getStateStamp()
        Returns a number that changes whenever the set of installed plug-ins changes. This can be used for invalidating caches that are based on the set of currently installed plug-ins. (e.g. extensions)

        Clients are also able to acquire the PlatformAdmin service and get the timestamp from its state object.

        Returns:
        a number related to the set of installed plug-ins
        Since:
        3.1
      • getLog

        public static ILog getLog​(Bundle bundle)
        Returns the log for the given bundle. If no such log exists, one is created.
        Parameters:
        bundle - the bundle whose log is returned
        Returns:
        the log for the given bundle
        Since:
        3.0
      • getLog

        public static ILog getLog​(Class<?> clazz)
        Returns the log for the bundle of the given class. If no such log exists, one is created.
        Parameters:
        clazz - the class in a bundle whose log is returned
        Returns:
        the log for the bundle to which the bundle belongs
        Since:
        3.16
      • getResourceBundle

        public static ResourceBundle getResourceBundle​(Bundle bundle)
                                                throws MissingResourceException
        Returns the given bundle's resource bundle for the current locale.

        This resource bundle is typically stored as the plugin.properties file in the plug-in itself, and contains any translatable strings used in the plug-in manifest file (plugin.xml).

        This mechanism is intended only for externalizing strings found in the plug-in manifest file. Using this method for externalizing strings in your code may result in degraded memory performance.

        Parameters:
        bundle - the bundle whose resource bundle is being queried
        Returns:
        the resource bundle
        Throws:
        MissingResourceException - if the resource bundle was not found
        Since:
        3.0
      • getResourceString

        public static String getResourceString​(Bundle bundle,
                                               String value)
        Returns a resource string corresponding to the given argument value. If the argument value specifies a resource key, the string is looked up in the default resource bundle for the given runtime bundle. If the argument does not specify a valid key, the argument itself is returned as the resource string. The key lookup is performed in the file referenced in the Bundle-Localization header of the bundle manifest. If a resource string corresponding to the key is not found in the resource bundle the key value, or any default text following the key in the argument value is returned as the resource string. A key is identified as a string beginning with the "%" character. Note, that the "%" character is stripped off prior to lookup in the resource bundle.

        Equivalent to getResourceString(bundle, value, getResourceBundle())

        Parameters:
        bundle - the bundle whose resource bundle is being queried
        value - the value to look for
        Returns:
        the resource string
        Since:
        3.0
        See Also:
        getResourceBundle(Bundle)
      • getResourceString

        public static String getResourceString​(Bundle bundle,
                                               String value,
                                               ResourceBundle resourceBundle)
        Returns a resource string corresponding to the given argument value and resource bundle in the given runtime bundle. If the argument value specifies a resource key, the string is looked up in the given resource bundle. If the argument does not specify a valid key, the argument itself is returned as the resource string. The key lookup is performed against the specified resource bundle. If a resource string corresponding to the key is not found in the resource bundle the key value, or any default text following the key in the argument value is returned as the resource string. A key is identified as a string beginning with the "%" character. Note that the "%" character is stripped off prior to lookup in the resource bundle.

        For example, assume resource bundle plugin.properties contains name = Project Name

             getResourceString("Hello World") returns "Hello World"
             getResourceString("%name") returns "Project Name"
             getResourceString("%name Hello World") returns "Project Name"
             getResourceString("%abcd Hello World") returns "Hello World"
             getResourceString("%abcd") returns "%abcd"
             getResourceString("%%name") returns "%name"
         
        Parameters:
        bundle - the bundle whose resource bundle is being queried
        value - the value
        resourceBundle - the resource bundle to query
        Returns:
        the resource string
        Since:
        3.0
        See Also:
        getResourceBundle(Bundle)
      • getOSArch

        public static String getOSArch()
        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").

        Clients are also able to acquire the EnvironmentInfo service and query it for the operating-system architecture.

        Returns:
        the string name of the current system architecture
        Since:
        3.0
      • getNL

        public static String getNL()
        Returns the string name of the current locale for use in finding files whose path starts with $nl$.

        Clients are also able to acquire the EnvironmentInfo service and query it for the NL.

        Returns:
        the string name of the current locale
        Since:
        3.0
      • getNLExtensions

        public static String getNLExtensions()
        Returns Unicode locale extensions for the Unicode locale identifier, if they are defined. An empty string is returned if Unicode locale extensions are not defined.

        For more information on Unicode locale extensions, see Unicode Technical Standard #35.

        Returns:
        The defined Unicode locale extensions, or an empty string.
        Since:
        3.5
      • getOS

        public static String getOS()
        Returns the string name of the current operating system for use in finding files whose path starts with $os$. OS_UNKNOWN is returned if the operating system cannot be determined. The value may indicate one of the operating systems known to the platform (as specified in knownOSValues) or a user-defined string if the operating system name is specified on the command line.

        Clients are also able to acquire the EnvironmentInfo service and query it for the operating-system.

        Returns:
        the string name of the current operating system
        Since:
        3.0
      • getWS

        public static String getWS()
        Returns the string name of the current window system for use in finding files whose path starts with $ws$. null is returned if the window system cannot be determined.

        Clients are also able to acquire the EnvironmentInfo service and query it for the windowing system.

        Returns:
        the string name of the current window system or null
        Since:
        3.0
      • getApplicationArgs

        public static String[] getApplicationArgs()
        Returns the arguments not consumed by the framework implementation itself. Which arguments are consumed is implementation specific. These arguments are available for use by the application.
        Returns:
        the array of command line arguments not consumed by the framework.
        Since:
        3.0
      • getPlatformAdmin

        public static PlatformAdmin getPlatformAdmin()
        Returns the platform administrator for this running Eclipse.

        Note: This is an internal method and must not be used by clients which are not part of the Eclipse Platform. This method allows access to classes which are not Eclipse Platform API but are part of the OSGi runtime that the Eclipse Platform is built on. Even as the Eclipse Platform evolves in compatible ways from release to release, the details of the OSGi implementation might not.

        Clients can also acquire the PlatformAdmin service to retrieve this object.

        Returns:
        the platform admin for this instance of Eclipse
        Since:
        3.0
      • getInstanceLocation

        public static Location getInstanceLocation()
        Returns the location of the platform's working directory (also known as the instance data area). null is returned if the platform is running without an instance location.

        This method is equivalent to acquiring the org.eclipse.osgi.service.datalocation.Location service with the property "type" equal to Location.INSTANCE_FILTER.

        Returns:
        the location of the platform's instance data area or null if none
        Since:
        3.0
        See Also:
        Location.INSTANCE_FILTER
      • getBundleGroupProviders

        public static IBundleGroupProvider[] getBundleGroupProviders()
        Returns the currently registered bundle group providers.

        Clients are also able to acquire the IBundleGroupProvider service and query it for the registered bundle group providers.

        Returns:
        the currently registered bundle group providers
        Since:
        3.0
      • getPreferencesService

        public static IPreferencesService getPreferencesService()
        Return the interface into the preference mechanism. The returned object can be used for such operations as searching for preference values across multiple scopes and preference import/export.

        Clients are also able to acquire the IPreferencesService service via OSGi mechanisms and use it for preference functions.

        Returns:
        an object to interface into the preference mechanism
        Since:
        3.0
      • getProduct

        public static IProduct getProduct()
        Returns the product which was selected when running this Eclipse instance or null if none
        Returns:
        the current product or null if none
        Since:
        3.0
      • registerBundleGroupProvider

        public static void registerBundleGroupProvider​(IBundleGroupProvider provider)
        Registers the given bundle group provider with the platform.

        Clients are also able to use the IBundleGroupProvider service to register themselves as a bundle group provider.

        Parameters:
        provider - a provider to register
        Since:
        3.0
      • getConfigurationLocation

        public static Location getConfigurationLocation()
        Returns the location of the configuration information used to run this instance of Eclipse. The configuration area typically contains the list of plug-ins available for use, various settings (those shared across different instances of the same configuration) and any other such data needed by plug-ins. null is returned if the platform is running without a configuration location.

        This method is equivalent to acquiring the org.eclipse.osgi.service.datalocation.Location service with the property "type" equal to Location.CONFIGURATION_FILTER.

        Returns:
        the location of the platform's configuration data area or null if none
        Since:
        3.0
        See Also:
        Location.CONFIGURATION_FILTER
      • getUserLocation

        public static Location getUserLocation()
        Returns the location of the platform's user data area. The user data area is a location on the system which is specific to the system's current user. By default it is located relative to the location given by the System property "user.home". null is returned if the platform is running without an user location.

        This method is equivalent to acquiring the org.eclipse.osgi.service.datalocation.Location service with the property "type" equal to Location.USER_FILTER.

        Returns:
        the location of the platform's user data area or null if none
        Since:
        3.0
        See Also:
        Location.USER_FILTER
      • getInstallLocation

        public static Location getInstallLocation()
        Returns the location of the base installation for the running platform null is returned if the platform is running without a configuration location.

        This method is equivalent to acquiring the org.eclipse.osgi.service.datalocation.Location service with the property "type" equal to Location.INSTALL_FILTER.

        Returns:
        the location of the platform's installation area or null if none
        Since:
        3.0
        See Also:
        Location.INSTALL_FILTER
      • isFragment

        public static boolean isFragment​(Bundle bundle)
        Checks if the specified bundle is a fragment bundle.

        Clients are also able to acquire the PackageAdmin service to query if the given bundle is a fragment by asking for the bundle type and checking against constants on the service interface.

        Parameters:
        bundle - the bundle to query
        Returns:
        true if the specified bundle is a fragment bundle; otherwise false is returned.
        Since:
        3.0
      • getFragments

        public static Bundle[] getFragments​(Bundle bundle)
        Returns an array of attached fragment bundles for the specified bundle. If the specified bundle is a fragment then null is returned. If no fragments are attached to the specified bundle then null is returned.

        Clients are also able to acquire the PackageAdmin service and query it for the fragments of the given bundle.

        Parameters:
        bundle - the bundle to get the attached fragment bundles for.
        Returns:
        an array of fragment bundles or null if the bundle does not have any attached fragment bundles.
        Since:
        3.0
      • getBundle

        public static Bundle getBundle​(String symbolicName)
        Returns the resolved bundle with the specified symbolic name that has the highest version. If no resolved bundles are installed that have the specified symbolic name then null is returned.

        Clients are also able to acquire the PackageAdmin service and query it for the bundle with the specified symbolic name. Clients can ask the service for all bundles with that particular name and then determine the one with the highest version. Note that clients may want to filter the results based on the state of the bundles.

        Parameters:
        symbolicName - the symbolic name of the bundle to be returned.
        Returns:
        the bundle that has the specified symbolic name with the highest version, or null if no bundle is found.
        Since:
        3.0
      • getBundles

        public static Bundle[] getBundles​(String symbolicName,
                                          String version)
        Returns all bundles with the specified symbolic name. If no resolved bundles with the specified symbolic name can be found, null is returned. If the version argument is not null then only the Bundles that have the specified symbolic name and a version greater than or equal to the specified version are returned. The returned bundles are ordered in descending bundle version order.

        Clients are also able to acquire the PackageAdmin service and query it for all bundle versions with the given symbolic name, after turning the specific version into a version range. Note that clients may want to filter the results based on the state of the bundles.

        Parameters:
        symbolicName - the symbolic name of the bundles that are to be returned.
        version - the version that the return bundle versions must match, or null if no version matching is to be done.
        Returns:
        the array of Bundles with the specified name that match the specified version and match rule, or null if no bundles are found.
      • getHosts

        public static Bundle[] getHosts​(Bundle bundle)
        Returns an array of host bundles that the specified fragment bundle is attached to or null if the specified bundle is not attached to a host. If the bundle is not a fragment bundle then null is returned.

        Clients are also able to acquire the PackageAdmin service and query it for the hosts for the given bundle.

        Parameters:
        bundle - the bundle to get the host bundles for.
        Returns:
        an array of host bundles or null if the bundle does not have any host bundles.
        Since:
        3.0
      • isRunning

        public static boolean isRunning()
        Returns whether the platform is running.
        Returns:
        true if the platform is running, and false otherwise
        Since:
        3.0
      • knownOSArchValues

        public static String[] knownOSArchValues()
        Returns a list of known system architectures.

        Note that this list is not authoritative; there may be legal values not included in this list. Indeed, the value returned by getOSArch may not be in this list. Also, this list may change over time as Eclipse comes to run on more operating environments.

        Returns:
        the list of system architectures known to the system
        Since:
        3.0
        See Also:
        getOSArch()
      • knownOSValues

        public static String[] knownOSValues()
        Returns a list of known operating system names.

        Note that this list is not authoritative; there may be legal values not included in this list. Indeed, the value returned by getOS may not be in this list. Also, this list may change over time as Eclipse comes to run on more operating environments.

        Returns:
        the list of operating systems known to the system
        Since:
        3.0
        See Also:
        getOS()
      • knownPlatformLineSeparators

        public static Map<String,​String> knownPlatformLineSeparators()
        Returns a map of known platform line separators. The keys are translated names of platforms and the values are their associated line separator strings.
        Returns:
        a map of platform to their line separator string
        Since:
        3.1
      • knownWSValues

        public static String[] knownWSValues()
        Returns a list of known windowing system names.

        Note that this list is not authoritative; there may be legal values not included in this list. Indeed, the value returned by getWS may not be in this list. Also, this list may change over time as Eclipse comes to run on more operating environments.

        Returns:
        the list of window systems known to the system
        Since:
        3.0
        See Also:
        getWS()
      • inDebugMode

        public static boolean inDebugMode()
        Returns true if the platform is currently running in debug mode. The platform is typically put in debug mode using the "-debug" command line argument.

        Clients are also able to acquire the EnvironmentInfo service and query it to see if they are in debug mode.

        Returns:
        whether or not the platform is running in debug mode
        Since:
        3.0
      • inDevelopmentMode

        public static boolean inDevelopmentMode()
        Returns true if the platform is currently running in development mode. That is, if special procedures are to be taken when defining plug-in class paths. The platform is typically put in development mode using the "-dev" command line argument.

        Clients are also able to acquire the EnvironmentInfo service and query it to see if they are in development mode.

        Returns:
        whether or not the platform is running in development mode
        Since:
        3.0