org.eclipse.core.resources
Interface IFileModificationValidator

public interface IFileModificationValidator

The file modification validator is a VCM-related hook for pre-checking operations that modify the contents of files.

This interface is used only in conjunction with the "org.eclipse.core.resources.fileModificationValidator" extension point. It is intended to be implemented only by the Eclipse Platform VCM plug-in.

Since:

2.0

Method Summary

IStatus	validateEdit(IFile[] files, Object context) Validates that the given files can be modified.
IStatus	validateSave(IFile file) Validates that the given file can be saved.

Method Detail

validateEdit

public IStatus validateEdit(IFile[] files,
                            Object context)

Validates that the given files can be modified. The files must all exist in the workspace. The optional context object may be supplied if UI-based validation is required. If the context is null, the validator must attempt to perform the validation in a headless manner. The returned status is IStatus.OK if this validator believes the given file can be modified. Other return statuses indicate the reason why the individual files cannot be modified.

Parameters:

files - the files that are to be modified; these files must all exist in the workspace

context - the org.eclipse.swt.widgets.Shell that is to be used to parent any dialogs with the user, or null if there is no UI context (declared as an Object to avoid any direct references on the SWT component)

Returns:

a status object that is OK if things are fine, otherwise a status describing reasons why modifying the given files is not a reasonable

See Also:

IWorkspace.validateEdit(org.eclipse.core.resources.IFile[], java.lang.Object)

validateSave

public IStatus validateSave(IFile file)

Validates that the given file can be saved. This method is called from IFile#setContents and IFile#appendContents before any attempt to write data to disk. The returned status is IStatus.OK if this validator believes the given file can be successfully saved. In all other cases the return value is a non-OK status. Note that a return value of IStatus.OK does not guarantee that the save will succeed.

Parameters:

file - the file that is to be modified; this file must exist in the workspace

Returns:

a status indicating whether or not it is reasonable to try writing to the given file; IStatus.OK indicates a save should be attempted.

See Also:

IFile.setContents(java.io.InputStream, boolean, boolean, org.eclipse.core.runtime.IProgressMonitor), IFile.appendContents(java.io.InputStream, boolean, boolean, org.eclipse.core.runtime.IProgressMonitor)