Eclipse Platform
Release 3.0

Uses of Interface
org.eclipse.core.runtime.IStatus

Packages that use IStatus
org.eclipse.compare Provides support for performing structural and textual compare operations on arbitrary data and displaying the results.  
org.eclipse.core.filebuffers Provides the API for accessing file buffers. 
org.eclipse.core.resources Provides basic support for managing a workspace and its resources.  
org.eclipse.core.resources.team Provides APIs intended to be implemented by the Team component.  
org.eclipse.core.runtime Provides core support for plug-ins and the plug-in registry.  
org.eclipse.core.runtime.jobs Provides core support for scheduling and interacting with background activity.  
org.eclipse.core.runtime.model Provides core support for the modeling plug-ins and the plug-in registry.  
org.eclipse.core.runtime.preferences Provides core support for Eclipse preferences.  
org.eclipse.core.variables Provides support for defining and contributing variables for the purpose of string substitution. 
org.eclipse.debug.core Provides support for launching programs, breakpoint management, expression management, and debug events. 
org.eclipse.debug.core.model Defines interfaces for debug model elements, source lookup, and launching. 
org.eclipse.debug.core.sourcelookup Provides support for source lookup. 
org.eclipse.debug.ui Provides a generic debugger user interface that clients may customize via standard workbench extension points. 
org.eclipse.jface.dialogs Provides support for dialogs.  
org.eclipse.jface.wizard Provides a framework for wizards.  
org.eclipse.search.ui Provides classes and interfaces to run search queries and manage their results.  
org.eclipse.team.core Application programming interfaces for defining and working with repository providers.  
org.eclipse.team.ui.synchronize Contains the team synchronization presentation framework and support for the Synchronize View. 
org.eclipse.ui Application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.  
org.eclipse.ui.actions Classes for actions and operations used in a workbench window, page, or part in the Eclipse Platform User Interface.  
org.eclipse.ui.application Application-level APIs for configuring and controling the Eclipse Platform User Interface.  
org.eclipse.ui.console Application programming interfaces for interaction with the Eclipse console. 
org.eclipse.ui.dialogs Classes for standard dialogs, wizards, and preference pages in the Eclipse Platform User Interface.  
org.eclipse.ui.editors.text Provides a standard text editor and concrete document providers based IFileBuffer and others directly handling IFile and IStorage as editor input. 
org.eclipse.ui.progress Application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.  
org.eclipse.ui.texteditor Provides a framework for text editors obeying to the desktop rules.  
org.eclipse.ui.wizards.datatransfer Provides the standard Import and Export wizards for moving resources into and out of the workspace. 
org.eclipse.update.configuration Provides support for accessing local installation information.  
org.eclipse.update.operations Provides support for performing various install/update operations.  
 

Uses of IStatus in org.eclipse.compare
 

Methods in org.eclipse.compare that return IStatus
 IStatus IStreamMerger.merge(OutputStream output, String outputEncoding, InputStream ancestor, String ancestorEncoding, InputStream target, String targetEncoding, InputStream other, String otherEncoding, IProgressMonitor monitor)
          Performs a merge operation on the given input streams and writes the merge result to the output stream.
 

Uses of IStatus in org.eclipse.core.filebuffers
 

Methods in org.eclipse.core.filebuffers that return IStatus
 IStatus IFileBuffer.getStatus()
          Returns the status of this file buffer.
 

Uses of IStatus in org.eclipse.core.resources
 

Subinterfaces of IStatus in org.eclipse.core.resources
 interface IResourceStatus
          Represents status related to resources in the Resources plug-in and defines the relevant status code constants.
 

Methods in org.eclipse.core.resources that return IStatus
 IStatus IWorkspace.copy(IResource[] resources, IPath destination, boolean force, IProgressMonitor monitor)
          Copies the given sibling resources so that they are located as members of the resource at the given path; the names of the copies are the same as the corresponding originals.
 IStatus IWorkspace.copy(IResource[] resources, IPath destination, int updateFlags, IProgressMonitor monitor)
          Copies the given sibling resources so that they are located as members of the resource at the given path; the names of the copies are the same as the corresponding originals.
 IStatus IWorkspace.delete(IResource[] resources, boolean force, IProgressMonitor monitor)
          Deletes the given resources.
 IStatus IWorkspace.delete(IResource[] resources, int updateFlags, IProgressMonitor monitor)
          Deletes the given resources.
 IStatus IWorkspace.move(IResource[] resources, IPath destination, boolean force, IProgressMonitor monitor)
          Moves the given sibling resources so that they are located as members of the resource at the given path; the names of the new members are the same.
 IStatus IWorkspace.move(IResource[] resources, IPath destination, int updateFlags, IProgressMonitor monitor)
          Moves the given sibling resources so that they are located as members of the resource at the given path; the names of the new members are the same.
 IStatus IWorkspace.save(boolean full, IProgressMonitor monitor)
          Saves this workspace's valuable state on disk.
 IStatus IWorkspace.validateEdit(IFile[] files, Object context)
          Advises that the caller intends to modify the contents of the given files in the near future and asks whether modifying all these files would be reasonable.
 IStatus IWorkspace.validateLinkLocation(IResource resource, IPath location)
          Validates the given path as the location of the given resource on disk.
 IStatus IWorkspace.validateName(String segment, int typeMask)
          Validates the given string as the name of a resource valid for one of the given types.
 IStatus IWorkspace.validateNatureSet(String[] natureIds)
          Validates that each of the given natures exists, and that all nature constraints are satisfied within the given set.
 IStatus IWorkspace.validatePath(String path, int typeMask)
          Validates the given string as a path for a resource of the given type(s).
 IStatus IWorkspace.validateProjectLocation(IProject project, IPath location)
          Validates the given path as the location of the given project on disk.
 IStatus IPathVariableManager.validateName(String name)
          Validates the given name as the name for a path variable.
 IStatus IPathVariableManager.validateValue(IPath path)
          Validates the given path as the value for a path variable.
abstract  IStatus WorkspaceJob.runInWorkspace(IProgressMonitor monitor)
          Runs the operation, reporting progress to and accepting cancelation requests from the given progress monitor.
 IStatus IFileModificationValidator.validateEdit(IFile[] files, Object context)
          Validates that the given files can be modified.
 IStatus IFileModificationValidator.validateSave(IFile file)
          Validates that the given file can be saved.
 

Uses of IStatus in org.eclipse.core.resources.team
 

Methods in org.eclipse.core.resources.team that return IStatus
 IStatus TeamHook.validateCreateLink(IFile file, int updateFlags, IPath location)
          Validates whether a particular attempt at link creation is allowed.
 IStatus TeamHook.validateCreateLink(IFolder folder, int updateFlags, IPath location)
          Validates whether a particular attempt at link creation is allowed.
 

Methods in org.eclipse.core.resources.team with parameters of type IStatus
 void IResourceTree.failed(IStatus reason)
          Declares that the operation has failed for the specified reason.
 

Uses of IStatus in org.eclipse.core.runtime
 

Classes in org.eclipse.core.runtime that implement IStatus
 class MultiStatus
          A concrete multi-status implementation, suitable either for instantiating or subclassing.
 class Status
          A concrete status implementation, suitable either for instantiating or subclassing.
 

Fields in org.eclipse.core.runtime declared as IStatus
static IStatus Status.OK_STATUS
          A standard OK status with an "ok" message.
static IStatus Status.CANCEL_STATUS
          A standard CANCEL status with no message.
 

Methods in org.eclipse.core.runtime that return IStatus
 IStatus[] MultiStatus.getChildren()
           
 IStatus[] IStatus.getChildren()
          Returns a list of status object immediately contained in this multi-status, or an empty list if this is not a multi-status.
 IStatus CoreException.getStatus()
          Returns the status object for this exception.
static IStatus Preferences.validatePreferenceVersions(IPath file)
          Validates that the preference versions in the given file match the versions of the currently installed plugins.
static IStatus PluginVersionIdentifier.validateVersion(String version)
          Validates the given string as a plug-in version identifier.
 IStatus[] Status.getChildren()
           
 

Methods in org.eclipse.core.runtime with parameters of type IStatus
 void MultiStatus.add(IStatus status)
          Adds the given status to this multi-status.
 void MultiStatus.addAll(IStatus status)
          Adds all of the children of the given status to this multi-status.
 void MultiStatus.merge(IStatus status)
          Merges the given status into this multi-status.
 void ILogListener.logging(IStatus status, String plugin)
          Notifies this listener that given status has been logged by a plug-in.
 void IProgressMonitorWithBlocking.setBlocked(IStatus reason)
          Indicates that this operation is blocked by some background activity.
 void ProgressMonitorWrapper.setBlocked(IStatus reason)
          This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor.
 void ILog.log(IStatus status)
          Logs the given status.
 

Constructors in org.eclipse.core.runtime with parameters of type IStatus
MultiStatus(String pluginId, int code, IStatus[] newChildren, String message, Throwable exception)
          Creates and returns a new multi-status object with the given children.
CoreException(IStatus status)
          Creates a new exception with the given status object.
 

Uses of IStatus in org.eclipse.core.runtime.jobs
 

Subinterfaces of IStatus in org.eclipse.core.runtime.jobs
 interface IJobStatus
          Represents status relating to the execution of jobs.
 

Fields in org.eclipse.core.runtime.jobs declared as IStatus
static IStatus Job.ASYNC_FINISH
          Job status return value that is used to indicate asynchronous job completion.
 

Methods in org.eclipse.core.runtime.jobs that return IStatus
 IStatus Job.getResult()
          Returns the result of this job's last run.
protected abstract  IStatus Job.run(IProgressMonitor monitor)
          Executes this job.
 IStatus IJobChangeEvent.getResult()
          The result returned by the job's run method, or null if not applicable.
 

Methods in org.eclipse.core.runtime.jobs with parameters of type IStatus
 void Job.done(IStatus result)
          Jobs that complete their execution asynchronously must indicate when they are finished by calling this method.
 

Uses of IStatus in org.eclipse.core.runtime.model
 

Methods in org.eclipse.core.runtime.model that return IStatus
 IStatus PluginRegistryModel.resolve(boolean trimDisabledPlugins, boolean doCrossLinking)
          Deprecated. Runs a resolve through the entire registry.
 

Methods in org.eclipse.core.runtime.model with parameters of type IStatus
 void Factory.error(IStatus error)
          Deprecated. Handles an error state specified by the status.
 

Uses of IStatus in org.eclipse.core.runtime.preferences
 

Methods in org.eclipse.core.runtime.preferences that return IStatus
 IStatus IPreferencesService.exportPreferences(IEclipsePreferences node, OutputStream output, String[] excludesList)
          Exports all preferences for the given preference node and all its children to the specified output stream.
 IStatus IPreferencesService.importPreferences(InputStream input)
          Loads preferences from the given file and stores them in the preferences store.
 IStatus IPreferencesService.applyPreferences(IExportedPreferences preferences)
          Take the given preference tree and apply it to the Eclipse global preference hierarchy.
 

Uses of IStatus in org.eclipse.core.variables
 

Methods in org.eclipse.core.variables with parameters of type IStatus
static void VariablesPlugin.log(IStatus status)
          Logs the specified status with this plug-in's log.
 

Uses of IStatus in org.eclipse.debug.core
 

Methods in org.eclipse.debug.core with parameters of type IStatus
 Object IStatusHandler.handleStatus(IStatus status, Object source)
          Notifies this status handler that the given status has been generated by the specified source object and requires resolution.
 IStatusHandler DebugPlugin.getStatusHandler(IStatus status)
          Returns the status handler registered for the given status, or null if none.
static void DebugPlugin.log(IStatus status)
          Logs the specified status with this plug-in's log.
 

Constructors in org.eclipse.debug.core with parameters of type IStatus
DebugException(IStatus status)
          Constructs a new debug exception with the given status object.
 

Uses of IStatus in org.eclipse.debug.core.model
 

Fields in org.eclipse.debug.core.model declared as IStatus
protected static IStatus LaunchConfigurationDelegate.promptStatus
          Status code for which a UI prompter is registered.
protected static IStatus LaunchConfigurationDelegate.switchToDebugPromptStatus
          Status code for which a prompter is registered to ask the user if they want to launch in debug mode when breakpoints are present.
protected static IStatus LaunchConfigurationDelegate.complileErrorPromptStatus
          Status code for which a prompter is registered to ask the user if the want to continue launch despite existing compile errors
 

Uses of IStatus in org.eclipse.debug.core.sourcelookup
 

Fields in org.eclipse.debug.core.sourcelookup declared as IStatus
protected static IStatus AbstractSourceLookupDirector.fPromptStatus
           
protected static IStatus AbstractSourceLookupDirector.fResolveDuplicatesStatus
           
 

Uses of IStatus in org.eclipse.debug.ui
 

Methods in org.eclipse.debug.ui with parameters of type IStatus
static int DebugUITools.openLaunchConfigurationDialogOnGroup(Shell shell, IStructuredSelection selection, String groupIdentifier, IStatus status)
          Open the launch configuration dialog with the specified initial selection.
static int DebugUITools.openLaunchConfigurationPropertiesDialog(Shell shell, ILaunchConfiguration configuration, String groupIdentifier, IStatus status)
          Open the launch configuration properties dialog on the specified launch configuration.
static int DebugUITools.openLaunchConfigurationDialog(Shell shell, ILaunchConfiguration configuration, String groupIdentifier, IStatus status)
          Open the launch configuration dialog on the specified launch configuration.
 

Uses of IStatus in org.eclipse.jface.dialogs
 

Methods in org.eclipse.jface.dialogs with parameters of type IStatus
protected  void ProgressMonitorDialog.updateForSetBlocked(IStatus reason)
          Set blocked state from the receiver.
 void IDialogBlockedHandler.showBlocked(Shell parentShell, IProgressMonitor blocking, IStatus blockingStatus, String blockedName)
          A blockage has occured.
 void IDialogBlockedHandler.showBlocked(IProgressMonitor blocking, IStatus blockingStatus, String blockedName)
          A blockage has occured.
static int ErrorDialog.openError(Shell parent, String dialogTitle, String message, IStatus status)
          Opens an error dialog to display the given error.
static int ErrorDialog.openError(Shell parentShell, String title, String message, IStatus status, int displayMask)
          Opens an error dialog to display the given error.
protected static boolean ErrorDialog.shouldDisplay(IStatus status, int mask)
          Returns whether the given status object should be displayed.
 

Constructors in org.eclipse.jface.dialogs with parameters of type IStatus
ErrorDialog(Shell parentShell, String dialogTitle, String message, IStatus status, int displayMask)
          Creates an error dialog.
 

Uses of IStatus in org.eclipse.jface.wizard
 

Fields in org.eclipse.jface.wizard declared as IStatus
protected  IStatus ProgressMonitorPart.blockedStatus
           
 

Methods in org.eclipse.jface.wizard with parameters of type IStatus
 void ProgressMonitorPart.setBlocked(IStatus reason)
           
 

Uses of IStatus in org.eclipse.search.ui
 

Methods in org.eclipse.search.ui that return IStatus
 IStatus ISearchQuery.run(IProgressMonitor monitor)
          This is the method that actually does the work, i.e. finds the results of the search query.
static IStatus NewSearchUI.runQueryInForeground(IRunnableContext context, ISearchQuery query)
          Runs the given search query.
 

Uses of IStatus in org.eclipse.team.core
 

Subinterfaces of IStatus in org.eclipse.team.core
 interface ITeamStatus
          Defines the status codes used in the status of exceptions and errors relating to Team.
 

Classes in org.eclipse.team.core that implement IStatus
 class TeamStatus
          Status that is returned from some Team operations or is the payload of some TeamExceptions.
 

Methods in org.eclipse.team.core that return IStatus
 IStatus RepositoryProvider.validateCreateLink(IResource resource, int updateFlags, IPath location)
          Method validateCreateLink is invoked by the Platform Core TeamHook when a linked resource is about to be added to the provider's project.
 

Constructors in org.eclipse.team.core with parameters of type IStatus
TeamException(IStatus status)
          Create a TeamException which contains the given status object.
 

Uses of IStatus in org.eclipse.team.ui.synchronize
 

Methods in org.eclipse.team.ui.synchronize that return IStatus
 IStatus SubscriberParticipant.refreshNow(IResource[] resources, String taskName, IProgressMonitor monitor)
          Refresh a participant.
 

Uses of IStatus in org.eclipse.ui
 

Constructors in org.eclipse.ui with parameters of type IStatus
PartInitException(IStatus status)
          Creates a new exception with the given status object.
WorkbenchException(IStatus status)
          Creates a new exception with the given status object.
 

Uses of IStatus in org.eclipse.ui.actions
 

Fields in org.eclipse.ui.actions declared as IStatus
protected  IStatus CopyProjectAction.errorStatus
          Status containing the errors detected when running the operation or null if no errors detected.
 

Uses of IStatus in org.eclipse.ui.application
 

Methods in org.eclipse.ui.application that return IStatus
 IStatus IWorkbenchConfigurer.restoreState()
          Restores the workbench state saved from the previous session, if any.
 

Uses of IStatus in org.eclipse.ui.console
 

Methods in org.eclipse.ui.console that return IStatus
static IStatus ConsolePlugin.newErrorStatus(String message, Throwable exception)
          Returns a new error status for this plugin with the given message
 

Methods in org.eclipse.ui.console with parameters of type IStatus
static void ConsolePlugin.log(IStatus status)
          Logs the specified status with this plug-in's log.
 

Uses of IStatus in org.eclipse.ui.dialogs
 

Methods in org.eclipse.ui.dialogs that return IStatus
 IStatus ISelectionStatusValidator.validate(Object[] selection)
          Validates an array of elements and returns the resulting status.
protected  IStatus WizardNewFolderMainPage.validateLinkedResource()
          Checks whether the linked resource target is valid.
protected  IStatus WizardNewFileCreationPage.validateLinkedResource()
          Checks whether the linked resource target is valid.
 

Methods in org.eclipse.ui.dialogs with parameters of type IStatus
protected  void SelectionStatusDialog.updateStatus(IStatus status)
          Update the dialog's status line to reflect the given status.
protected  void SelectionStatusDialog.updateButtonsEnableState(IStatus status)
          Update the status of the ok button to reflect the given status.
protected  void NewFolderDialog.updateStatus(IStatus status)
          Update the dialog's status line to reflect the given status.
 

Uses of IStatus in org.eclipse.ui.editors.text
 

Methods in org.eclipse.ui.editors.text that return IStatus
 IStatus ForwardingDocumentProvider.getStatus(Object element)
           
 IStatus TextFileDocumentProvider.getStatus(Object element)
           
 IStatus TextFileDocumentProvider.NullProvider.getStatus(Object element)
           
 

Methods in org.eclipse.ui.editors.text with parameters of type IStatus
protected  String TextEditor.getStatusHeader(IStatus status)
           
protected  String TextEditor.getStatusBanner(IStatus status)
           
protected  String TextEditor.getStatusMessage(IStatus status)
           
 String DefaultEncodingSupport.getStatusHeader(IStatus status)
          Returns a status header for the given status.
 String DefaultEncodingSupport.getStatusBanner(IStatus status)
          Returns a banner for the given status.
 String DefaultEncodingSupport.getStatusMessage(IStatus status)
          Returns a status message if any.
 

Uses of IStatus in org.eclipse.ui.progress
 

Methods in org.eclipse.ui.progress that return IStatus
static IStatus UIJob.errorStatus(Throwable exception)
          Convenience method to return a status for an exception.
 IStatus UIJob.run(IProgressMonitor monitor)
           
abstract  IStatus UIJob.runInUIThread(IProgressMonitor monitor)
          Run the job in the UI Thread.
 

Uses of IStatus in org.eclipse.ui.texteditor
 

Fields in org.eclipse.ui.texteditor declared as IStatus
protected static IStatus AbstractDocumentProvider.STATUS_OK
          Constant for representing the OK status.
protected static IStatus AbstractDocumentProvider.STATUS_ERROR
          Constant for representing the error status.
 IStatus AbstractDocumentProvider.ElementInfo.fStatus
          The status of this element
 

Methods in org.eclipse.ui.texteditor that return IStatus
 IStatus IDocumentProviderExtension.getStatus(Object element)
          Returns the status of the given element.
 IStatus AbstractDocumentProvider.getStatus(Object element)
           
 

Methods in org.eclipse.ui.texteditor with parameters of type IStatus
protected  boolean StatusTextEditor.isErrorStatus(IStatus status)
          Returns whether the given status indicates an error.
protected  Control StatusTextEditor.createStatusControl(Composite parent, IStatus status)
          Creates the status control for the given status.
protected  String StatusTextEditor.getStatusHeader(IStatus status)
          Returns a header for the given status
protected  String StatusTextEditor.getStatusBanner(IStatus status)
          Returns a banner for the given status.
protected  String StatusTextEditor.getStatusMessage(IStatus status)
          Returns a message for the given status.
protected  boolean AbstractDecoratedTextEditor.isErrorStatus(IStatus status)
           
 

Constructors in org.eclipse.ui.texteditor with parameters of type IStatus
ValidateStateException(IStatus status)
          Deprecated.  
 

Uses of IStatus in org.eclipse.ui.wizards.datatransfer
 

Methods in org.eclipse.ui.wizards.datatransfer that return IStatus
 IStatus ImportOperation.getStatus()
          Returns the status of the import operation.
 

Uses of IStatus in org.eclipse.update.configuration
 

Methods in org.eclipse.update.configuration that return IStatus
 IStatus ILocalSite.getFeatureStatus(IFeature feature)
          Indicates if the 'state' of the specified feature and its children features.
 IStatus IConfiguredSite.verifyUpdatableStatus()
          Indicates whether updates can be applied to the site.
 IStatus IConfiguredSite.getBrokenStatus(IFeature feature)
          Indicates if the specified feature is "broken".
 

Uses of IStatus in org.eclipse.update.operations
 

Methods in org.eclipse.update.operations that return IStatus
 IStatus IOperationValidator.validatePendingInstall(IFeature oldFeature, IFeature newFeature)
          Called before performing install.
 IStatus IOperationValidator.validatePendingConfig(IFeature feature)
          Called before performing operation.
 IStatus IOperationValidator.validatePendingUnconfig(IFeature feature)
          Called before performing operation.
 IStatus IOperationValidator.validatePendingReplaceVersion(IFeature feature, IFeature anotherFeature)
          Called before performing operation.
 IStatus IOperationValidator.validatePendingRevert(IInstallConfiguration config)
          Called before doing a revert/ restore operation
 IStatus IOperationValidator.validatePendingChanges(IInstallFeatureOperation[] jobs)
          Called by the UI before doing a batched processing of several pending changes.
 IStatus IOperationValidator.validateCurrentState()
          Check the current state.
 IStatus IOperationValidator.validatePlatformConfigValid()
          Checks if the platform configuration has been modified outside this program.
 


Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.