Eclipse Platform
Release 3.3

org.eclipse.ltk.core.refactoring.participants
Class ResourceChangeChecker

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.participants.ResourceChangeChecker
All Implemented Interfaces:
IConditionChecker

public class ResourceChangeChecker
extends Object
implements IConditionChecker

A resource operation checker is a shared checker to collect all changes done by the refactoring and the participants to resources so that they can be validated as one change. A resource operation checker supersedes the ValidateEditChecker. So if clients add their content changes to this checker there is no need to add them to the ValidateEditChecker as well.

Note: this class is not intended to be extended by clients.

Since:
3.2
See Also:
ResourceChangeValidator

Constructor Summary
ResourceChangeChecker()
           
 
Method Summary
 RefactoringStatus check(IProgressMonitor monitor)
          Performs the actual condition checking.
static RefactoringStatus checkFilesToBeChanged(IFile[] files, IProgressMonitor monitor)
          A helper method to check a set of changed files.
 IResourceChangeDescriptionFactory getDeltaFactory()
          Returns the delta factory to be used to record resource operations.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceChangeChecker

public ResourceChangeChecker()
Method Detail

checkFilesToBeChanged

public static RefactoringStatus checkFilesToBeChanged(IFile[] files,
                                                      IProgressMonitor monitor)
                                               throws CoreException
A helper method to check a set of changed files.

Parameters:
files - the array of files that change
monitor - a progress monitor to report progress or null if progress reporting is not desired
Returns:
a refactoring status containing the detect problems
Throws:
CoreException - a CoreException if an error occurs
See Also:
ResourceChangeValidator.validateChange(IResourceDelta, IProgressMonitor)

getDeltaFactory

public IResourceChangeDescriptionFactory getDeltaFactory()
Returns the delta factory to be used to record resource operations.

Returns:
the delta factory

check

public RefactoringStatus check(IProgressMonitor monitor)
                        throws CoreException
Description copied from interface: IConditionChecker
Performs the actual condition checking.

Specified by:
check in interface IConditionChecker
Parameters:
monitor - a progress monitor to report progress
Returns:
the outcome of the condition check
Throws:
CoreException - if an error occurred during condition checking. The check is interpreted as failed if this happens

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

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