public abstract class RefreshProvider
- extends org.eclipse.core.internal.refresh.InternalRefreshProvider
The abstract base class for all auto-refresh providers. This class provides
the infrastructure for defining an auto-refresh provider and fulfills the
contract specified by the
standard extension point.
All auto-refresh providers must subclass this class. A
RefreshProvider is responsible for creating
IRefreshMonitor objects. The provider must decide if
it is capable of monitoring the file, or folder and subtree under the path that is provided.
Methods inherited from class java.lang.
- Creates a new refresh monitor that performs naive polling of the resource
in the file system to detect changes. The returned monitor will immediately begin
monitoring the specified resource root and report changes back to the workspace.
This default monitor can be returned by subclasses when
installMonitor is called.
If the returned monitor is not immediately returned from the
method, then clients are responsible for telling the returned monitor to
stop polling when it is no longer needed. The returned monitor can be told to
stop working by invoking
createPollingMonitor in class
resource - The resource to begin monitoring
- A refresh monitor instance
- Returns an
IRefreshMonitor that will monitor a resource. If
the resource is an
IContainer the monitor will also
monitor the subtree under the container. Returns
this provider cannot create a monitor for the given resource. The
provider may return the same monitor instance that has been provided for
The monitor should send results and failures to the provided refresh
resource - the resource to monitor
result - the result callback for notifying of failure or of resources that need
- a monitor on the resource, or
if the resource cannot be monitored
public void resetMonitors(
- Resets the installed monitors for the given resource. This will remove all
existing monitors that are installed on the resource, and then ask all
refresh providers to begin monitoring the resource again.
This method is intended to be used by refresh providers that need to change
the refresh monitor that they previously used to monitor a resource.
resetMonitors in class
resource - The resource to reset the monitors for
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.