Eclipse Platform
Release 3.3

org.eclipse.team.core.mapping
Interface IChangeGroupingRequestor


public interface IChangeGroupingRequestor

Interface used to allow model tooling to request that a particular set of modified files be committed together to the repository. It is used by the ChangeTracker class to track changes and request that they be grouped when appropriate. Clients may obtain an instance of this interface from a repository provider plug-in using the adapter manager in the following way:

  RepositoryProvderType type = ....
 	Object o = type.getAdapter(IChangeGroupingRequestor.class);
 	if (o instanceof IChangeGroupingRequestor) {
 		return (IChangeGroupingRequestor) o;
	}
 

Clients may implement this interface.

Since:
3.3
See Also:
ChangeTracker

Method Summary
 void ensureChangesGrouped(IProject project, IFile[] files, String nameHint)
          Issue a request to group the provided files together when the changes are committed or checked-in to the repository.
 boolean isModified(IFile file)
          Return whether the given file is modified with respect to the repository.
 

Method Detail

ensureChangesGrouped

public void ensureChangesGrouped(IProject project,
                                 IFile[] files,
                                 String nameHint)
                          throws CoreException
Issue a request to group the provided files together when the changes are committed or checked-in to the repository.

Parameters:
project - the project that contains the files
files - the files
nameHint - a name hint for the resulting set
Throws:
CoreException - if an error occurs

isModified

public boolean isModified(IFile file)
                   throws CoreException
Return whether the given file is modified with respect to the repository. In other words, return whether the file contains changes that need to be committed or checked-in to the repository.

Parameters:
file - the file
Returns:
whether the given file is modified with respect to the repository
Throws:
CoreException - if an error occurs while trying to determine the modification state of the file

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

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