http://www.eclipse.org/platform: Core Resource Management (Eclipse Foundation) 
 Copyright (c) 2004, 2014 IBM Corporation and others.
 This program and the accompanying materials
 are made available under the terms of the Eclipse Public License 2.0
 which accompanies this distribution, and is available at
 https://www.eclipse.org/legal/epl-2.0/
 SPDX-License-Identifier: EPL-2.0
 Contributors:
    IBM - Initial API and implementation

/*******************************************************************************
 *  Copyright (c) 2004, 2014 IBM Corporation and others.
 *
 *  This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License 2.0
 *  which accompanies this distribution, and is available at
 *  https://www.eclipse.org/legal/epl-2.0/
 *
 *  SPDX-License-Identifier: EPL-2.0
 *
 *  Contributors:
 *     IBM - Initial API and implementation
 *******************************************************************************/
package org.eclipse.core.resources.refresh;

import org.eclipse.core.internal.refresh.InternalRefreshProvider;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;


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 org.eclipse.core.resources.refreshProviders
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.


Note: since 3.12, all subclasses should override installMonitor(IResource, IRefreshResult, IProgressMonitor) instead of installMonitor(IResource, IRefreshResult). 
Since:3.0
/**
 * 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 <code>org.eclipse.core.resources.refreshProviders</code>
 * standard extension point.
 * <p>
 * All auto-refresh providers must subclass this class. A
 * <code>RefreshProvider</code> is responsible for creating
 * <code>IRefreshMonitor</code> objects.  The provider must decide if
 * it is capable of monitoring the file, or folder and subtree under the path that is provided.
 * <p>
 * <b>Note:</b> since 3.12, all subclasses should override {@link #installMonitor(IResource, IRefreshResult, IProgressMonitor)}
 * instead of {@link #installMonitor(IResource, IRefreshResult)}.
 * @since 3.0
 */
public abstract class RefreshProvider extends InternalRefreshProvider {
	
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 installMonitor
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 IRefreshMonitor.unmonitor(IResource).

Params:
  • resource – The resource to begin monitoring
See Also:
Returns:A refresh monitor instance
/**
	 * 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.
	 * <p>
	 * This default monitor can be returned by subclasses  when
	 * <code>installMonitor</code> is called.
	 * <p>
	 * If the returned monitor is not immediately returned from the <code>installMonitor</code>
	 * 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 <code>IRefreshMonitor.unmonitor(IResource)</code>.
	 *
	 * @param resource The resource to begin monitoring
	 * @return A refresh monitor instance
	 * @see #installMonitor(IResource, IRefreshResult)
	 */
	@Override
	protected IRefreshMonitor createPollingMonitor(IResource resource) {
		return super.createPollingMonitor(resource);
	}

	
See Also:
Deprecated:Subclasses should override and clients should call installMonitor(IResource, IRefreshResult, IProgressMonitor) instead.
/**
	 * @deprecated Subclasses should override and clients should call
	 * {@link #installMonitor(IResource, IRefreshResult, IProgressMonitor)} instead.
	 * @see #installMonitor(IResource, IRefreshResult, IProgressMonitor)
	 */
	@Deprecated
	public IRefreshMonitor installMonitor(IResource resource, IRefreshResult result) {
		return null;
	}

	
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 null if
this provider cannot create a monitor for the given resource.  The
provider may return the same monitor instance that has been provided for
other resources.


The monitor should send results and failures to the provided refresh
result.

Params:
  • resource – the resource to monitor
  • result – the result callback for notifying of failure or of resources that need
refreshing
  • progressMonitor – the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor. Accepts null,
indicating that no progress should be reported and that the operation cannot be cancelled.
See Also:
Returns:a monitor on the resource, or null
if the resource cannot be monitored
Since:3.12
/**
	 * Returns an <code>IRefreshMonitor</code> that will monitor a resource. If
	 * the resource is an <code>IContainer</code> the monitor will also
	 * monitor the subtree under the container. Returns <code>null</code> if
	 * this provider cannot create a monitor for the given resource.  The
	 * provider may return the same monitor instance that has been provided for
	 * other resources.
	 * <p>
	 * The monitor should send results and failures to the provided refresh
	 * result.
	 *
	 * @param resource the resource to monitor
	 * @param result the result callback for notifying of failure or of resources that need
	 * refreshing
	 * @param progressMonitor the progress monitor to use for reporting progress to the user.
	 * It is the caller's responsibility to call done() on the given monitor. Accepts null,
	 * indicating that no progress should be reported and that the operation cannot be cancelled.
	 * @return a monitor on the resource, or <code>null</code>
	 * if the resource cannot be monitored
	 * @see #createPollingMonitor(IResource)
	 * @since 3.12
	 */
	public IRefreshMonitor installMonitor(IResource resource, IRefreshResult result, IProgressMonitor progressMonitor) {
		return installMonitor(resource, result);
	}

	
Deprecated:Subclasses should override and clients should call resetMonitors(IResource, IProgressMonitor) instead.
/**
	 * @deprecated Subclasses should override and clients should call
	 * {@link #resetMonitors(IResource, IProgressMonitor)} instead.
	 */
	@Deprecated
	public void resetMonitors(IResource resource) {
		this.resetMonitors(resource, new NullProgressMonitor());
	}

	
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.

Params:
  • resource – The resource to reset the monitors for
  • progressMonitor – the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor. Accepts null,
indicating that no progress should be reported and that the operation cannot be cancelled.
Since:3.12
/**
	 * 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.
	 * <p>
	 * 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.
	 *
	 * @param resource The resource to reset the monitors for
	 * @param progressMonitor the progress monitor to use for reporting progress to the user.
	 * It is the caller's responsibility to call done() on the given monitor. Accepts null,
	 * indicating that no progress should be reported and that the operation cannot be cancelled.
	 * @since 3.12
	 */
	@Override
	public void resetMonitors(IResource resource, IProgressMonitor progressMonitor) {
		super.resetMonitors(resource, progressMonitor);
	}
}