org.eclipse.core.resources.team.FileModificationValidationContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*******************************************************************************
 * Copyright (c) 2007 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.core.resources.team;

import org.eclipse.core.resources.IWorkspace;

/**
 * A context that is used in conjunction with the {@link FileModificationValidator}
 * to indicate that UI-based validation is desired.
 * 
 * This class is not intended to be instantiated or subclassed by clients.
 *
 * @see FileModificationValidator
 * @since 3.3
 */
public class FileModificationValidationContext {

	/**
	 * Constant that can be passed to {@link IWorkspace#validateEdit(org.eclipse.core.resources.IFile[], Object)}
	 * to indicate that the caller does not have access to a UI context but would still
	 * like to have UI-based validation if possible.
	 */
	public static final FileModificationValidationContext VALIDATE_PROMPT = new FileModificationValidationContext(null);

	private final Object shell;

	/**
	 * Create a context with the given shell.
	 *
	 * @param shell the shell
	 */
	FileModificationValidationContext(Object shell) {
		this.shell = shell;
	}

	/**
	 * Return 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
	 * available (declared as an Object to avoid any direct references on the SWT component).
	 * If there is no shell, the {@link FileModificationValidator} may still perform
	 * UI-based validation if they can obtain a Shell from another source.
	 * @return the org.eclipse.swt.widgets.Shell that is to be used to
	 *    parent any dialogs with the user, or null
	 */
	public Object getShell() {
		return shell;
	}
}