Copyright (c) 2000, 2018 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 Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2000, 2018 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 Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ltk.core.refactoring.participants;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;

import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ltk.core.refactoring.resource.Resources;
import org.eclipse.ltk.internal.core.refactoring.RefactoringCoreMessages;

A validate edit checker is a shared checker to collect files
to be validated all at once. A validate edit checker checks
if the files are in sync with the underlying files system.
Additionally IWorkspace#validateEdit is called for
all read-only resources.
 Note: Since 3.2, a ResourceChangeChecker exists. If clients add their changed files to the ResourceChangeChecker there is no need to add them to a validate edit checker as well. Files marked as changed in the resource operation checker will be automatically added to a validate edit checker (if one exists). 

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

See Also:
IWorkspace.validateEdit(IFile[], Object)
Since:
3.0
@noextend
This class is not intended to be subclassed by clients./**
 * A validate edit checker is a shared checker to collect files
 * to be validated all at once. A validate edit checker checks
 * if the files are in sync with the underlying files system.
 * Additionally <code>IWorkspace#validateEdit</code> is called for
 * all read-only resources.
 * <p>
 * Note: Since 3.2, a {@link ResourceChangeChecker} exists. If clients
 * add their changed files to the {@link ResourceChangeChecker}
 * there is no need to add them to a validate edit checker as
 * well. Files marked as changed in the resource operation checker
 * will be automatically added to a validate edit checker (if one
 * exists).
 * </p>
 * <p>
 * Note: this class is not intended to be extended by clients.
 * </p>
 *
 * @see org.eclipse.core.resources.IWorkspace#validateEdit(org.eclipse.core.resources.IFile[], java.lang.Object)
 *
 * @since 3.0
 *
 * @noextend This class is not intended to be subclassed by clients.
 */
public class ValidateEditChecker implements IConditionChecker {

	private Set<IFile> fFiles= new HashSet<>();
	private Object fContext;

	
The context passed to the validate edit call.
Params:
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)
See Also:
IWorkspace.validateEdit(IFile[], Object)/**
	 * The context passed to the validate edit call.
	 *
	 * @param context the <code>org.eclipse.swt.widgets.Shell</code> that is
	 * to be used to parent any dialogs with the user, or <code>null</code> if
	 * there is no UI context (declared as an <code>Object</code> to avoid any
	 * direct references on the SWT component)
	 *
	 * @see org.eclipse.core.resources.IWorkspace#validateEdit(org.eclipse.core.resources.IFile[], java.lang.Object)
	 */
	public ValidateEditChecker(Object context) {
		fContext= context;
	}

	
Adds the given file to this checker.
Params:
file – the file to add/**
	 * Adds the given file to this checker.
	 *
	 * @param file the file to add
	 */
	public void addFile(IFile file) {
		Assert.isNotNull(file);
		fFiles.add(file);
	}

	
Adds the given array of files.
Params:
files – the array of files to add/**
	 * Adds the given array of files.
	 *
	 * @param files the array of files to add
	 */
	public void addFiles(IFile[] files) {
		Assert.isNotNull(files);
		fFiles.addAll(Arrays.asList(files));
	}

	@Override
	public RefactoringStatus check(IProgressMonitor monitor) throws CoreException {
		IResource[] resources= fFiles.toArray(new IResource[fFiles.size()]);
		RefactoringStatus result= new RefactoringStatus();
		IStatus status= Resources.checkInSync(resources);
		if (!status.isOK())
			result.merge(RefactoringStatus.create(status));
		status= Resources.makeCommittable(resources, fContext);
		if (!status.isOK()) {
			result.merge(RefactoringStatus.create(status));
			if (!result.hasFatalError()) {
				result.addFatalError(RefactoringCoreMessages.ValidateEditChecker_failed);
			}
		}
		return result;
	}
}