Copyright (c) 2000, 2008 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
/*******************************************************************************
 * Copyright (c) 2000, 2008 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
 *******************************************************************************/
package org.eclipse.ltk.core.refactoring;

import org.eclipse.core.runtime.Assert;

import org.eclipse.core.resources.IFile;

import org.eclipse.jface.text.IRegion;

A file context can be used to annotate a RefactoringStatusEntry with
detailed information about a problem detected in an IFile.

Note: this class is not intended to be extended by clients.

Since:
3.0
@noextend
This class is not intended to be subclassed by clients./**
 * A file context can be used to annotate a <code>RefactoringStatusEntry</code> with
 * detailed information about a problem detected in an <code>IFile</code>.
 * <p>
 * Note: this class is not intended to be extended by clients.
 * </p>
 *
 * @since 3.0
 *
 * @noextend This class is not intended to be subclassed by clients.
 */
public class FileStatusContext extends RefactoringStatusContext {

	private IFile fFile;
	private IRegion fSourceRegion;

	
Creates an status entry context for the given file and source region.
Params:
file – the file that has caused the problem. Must not be 
 null
region – the source region of the problem inside the given file or
 null if now source region is known/**
	 * Creates an status entry context for the given file and source region.
	 *
	 * @param file the file that has caused the problem. Must not be <code>
	 *  null</code>
	 * @param region the source region of the problem inside the given file or
	 *  <code>null</code> if now source region is known
	 */
	public FileStatusContext(IFile file, IRegion region) {
		Assert.isNotNull(file);
		fFile= file;
		fSourceRegion= region;
	}

	
Returns the context's file.
Returns:
the context's file/**
	 * Returns the context's file.
	 *
	 * @return the context's file
	 */
	public IFile getFile() {
		return fFile;
	}

	
Returns the context's source region
Returns:
the context's source region or null if no source region
 has been set/**
	 * Returns the context's source region
	 *
	 * @return the context's source region or <code>null</code> if no source region
	 *  has been set
	 */
	public IRegion getTextRegion() {
		return fSourceRegion;
	}

	@Override
	public Object getCorrespondingElement() {
		return getFile();
	}
}