01: /*
02: * Spoon - http://spoon.gforge.inria.fr/
03: * Copyright (C) 2006 INRIA Futurs <renaud.pawlak@inria.fr>
04: *
05: * This software is governed by the CeCILL-C License under French law and
06: * abiding by the rules of distribution of free software. You can use, modify
07: * and/or redistribute the software under the terms of the CeCILL-C license as
08: * circulated by CEA, CNRS and INRIA at http://www.cecill.info.
09: *
10: * This program is distributed in the hope that it will be useful, but WITHOUT
11: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12: * FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C License for more details.
13: *
14: * The fact that you are presently reading this means that you have had
15: * knowledge of the CeCILL-C license and that you accept its terms.
16: */
17:
18: package spoon.processing;
19:
20: import spoon.reflect.Changes;
21: import spoon.reflect.declaration.CtElement;
22:
23: /**
24: * This interface defines problem fixers. Problem fixers can be provided when a
25: * problem is reported to the environment. The user can then chose what fixer to
26: * use.
27: *
28: * @see Environment#report(Processor, Severity, CtElement, String,
29: * ProblemFixer[])
30: */
31: public interface ProblemFixer<T extends CtElement> extends
32: FactoryAccessor {
33:
34: /**
35: * Returns the description of this fixer
36: */
37: public abstract String getDescription();
38:
39: /**
40: * Returns a short String that represent this fixer.
41: */
42: public abstract String getLabel();
43:
44: /**
45: * Runs this fix on given element. This fixer should modify the given model
46: * and return a list of the modified elements.
47: *
48: * @param element
49: * the element marked by a problem
50: * @return List of modified elements
51: */
52: public abstract Changes run(T element);
53: }
|