Case Study: adding data and statistics

[ifi-stolz-refaktor.git] / case-study / jdt-after / ui / org / eclipse / jdt / ui / cleanup / ICleanUpFix.java

diff --git a/case-study/jdt-after/ui/org/eclipse/jdt/ui/cleanup/ICleanUpFix.java b/case-study/jdt-after/ui/org/eclipse/jdt/ui/cleanup/ICleanUpFix.java
new file mode 100644 (file)
index 0000000..cd9821e
--- /dev/null
+++ b/case-study/jdt-after/ui/org/eclipse/jdt/ui/cleanup/ICleanUpFix.java
@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * Copyright (c) 2008 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.jdt.ui.cleanup;
+
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+
+import org.eclipse.jdt.core.refactoring.CompilationUnitChange;
+
+
+/**
+ * A clean up fix calculates a {@link CompilationUnitChange} which can be applied on a document to
+ * fix one or more problems in a compilation unit.
+ * 
+ * @since 3.5
+ */
+public interface ICleanUpFix {
+
+       /**
+        * Calculates and returns a {@link CompilationUnitChange} which can be applied on a document to
+        * fix one or more problems in a compilation unit.
+        * 
+        * @param progressMonitor the progress monitor or <code>null</code> if none
+        * @return a compilation unit change change which should not be empty
+        * @throws CoreException if something went wrong while calculating the change
+        */
+       public CompilationUnitChange createChange(IProgressMonitor progressMonitor) throws CoreException;
+
+}