KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ltk > core > refactoring > participants > IConditionChecker


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ltk.core.refactoring.participants;
12
13 import org.eclipse.core.runtime.CoreException;
14 import org.eclipse.core.runtime.IProgressMonitor;
15
16 import org.eclipse.ltk.core.refactoring.RefactoringStatus;
17
18 /**
19  * A condition checker can be used to share condition checks
20  * across the main processor and all its associated participants.
21  * <p>
22  * This interface should be implemented by clients wishing to provide a
23  * special refactoring processor with special shared condition checks.
24  * </p>
25  *
26  * @see org.eclipse.ltk.core.refactoring.participants.CheckConditionsContext
27  *
28  * @since 3.0
29  */
30 public interface IConditionChecker {
31
32     /**
33      * Performs the actual condition checking.
34      *
35      * @param monitor a progress monitor to report progress
36      * @return the outcome of the condition check
37      *
38      * @throws CoreException if an error occurred during condition
39      * checking. The check is interpreted as failed if this happens
40      */
41     public RefactoringStatus check(IProgressMonitor monitor) throws CoreException;
42 }
43
Popular Tags