ICleanUpFix.java

/*******************************************************************************
 * 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.che.ide.ext.java.jdt.internal.corext.fix;

import org.eclipse.che.ide.ext.java.jdt.internal.corext.refactoring.code.CompilationUnitChange;
import org.eclipse.che.ide.runtime.CoreException;


/**
 * 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.
     *
     * @return a compilation unit change change which should not be empty
     * @throws CoreException
     *         if something went wrong while calculating the change
     */
    public CompilationUnitChange createChange() throws CoreException;

}