Copyright (c) 2008, 2019 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
    Red Hat Inc. - refactored to jdt.core.manipultion
/*******************************************************************************
 * Copyright (c) 2008, 2019 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
 *     Red Hat Inc. - refactored to jdt.core.manipultion
 *******************************************************************************/
package org.eclipse.jdt.core.manipulation;

import org.eclipse.core.runtime.Assert;

import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.dom.CompilationUnit;


The context that contains all information required by a clean up to create a fix.
Since:
1.12/**
 * The context that contains all information required by a clean up to create a fix.
 *
 * @since 1.12
 */
public class CleanUpContextCore {

	private final ICompilationUnit fUnit;

	private final CompilationUnit fAst;

	
Creates a new clean up context.
Params:
unit – the compilation unit
ast – the AST, can be null if CleanUpRequirementsCore.requiresAST() returns false. The AST is guaranteed to contain changes made by previous clean ups only if CleanUpRequirementsCore.requiresFreshAST() returns true./**
	 * Creates a new clean up context.
	 *
	 * @param unit the compilation unit
	 * @param ast the AST, can be <code>null</code> if {@link CleanUpRequirementsCore#requiresAST()}
	 *            returns <code>false</code>. The AST is guaranteed to contain changes made by
	 *            previous clean ups only if {@link CleanUpRequirementsCore#requiresFreshAST()} returns
	 *            <code>true</code>.
	 */
	public CleanUpContextCore(ICompilationUnit unit, CompilationUnit ast) {
		Assert.isLegal(unit != null);
		fUnit= unit;
		fAst= ast;
	}

	
The compilation unit to clean up.
Returns:
the compilation unit to clean up/**
	 * The compilation unit to clean up.
	 *
	 * @return the compilation unit to clean up
	 */
	public ICompilationUnit getCompilationUnit() {
		return fUnit;
	}

	
An AST built from the compilation unit to fix.

Can be null if CleanUpRequirementsCore.requiresAST() returns false. The AST is guaranteed to contain changes made by previous clean ups only if CleanUpRequirementsCore.requiresFreshAST() returns true.

Clients should check the AST API level and do nothing if they are given an AST they can't handle (see AST.apiLevel()). 
Returns:
an AST or null if none required/**
	 * An AST built from the compilation unit to fix.
	 * <p>
	 * Can be <code>null</code> if {@link CleanUpRequirementsCore#requiresAST()} returns
	 * <code>false</code>. The AST is guaranteed to contain changes made by previous clean ups only
	 * if {@link CleanUpRequirementsCore#requiresFreshAST()} returns <code>true</code>.
	 * </p>
	 * <p>Clients should check the AST API level and do nothing if they are given an AST
	 * they can't handle (see {@link org.eclipse.jdt.core.dom.AST#apiLevel()}).
	 *
	 * @return an AST or <code>null</code> if none required
	 */
	public CompilationUnit getAST() {
		return fAst;
	}
}