http://www.eclipse.org/platform: Refactoring Core (Eclipse Foundation) 
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;


A RefactoringStatusContext can be used to annotate a RefactoringStatusEntry with additional information typically presented in the user interface. 

To present a context in the user interface a corresponding context
viewer can be registered via the extension point 
org.eclipse.ltk.ui.refactoring.statusContextViewers.




This class may be subclassed by clients.



Since:3.0
/**
 * A <code>RefactoringStatusContext</code> can be used to annotate a
 * {@link RefactoringStatusEntry} with additional information
 * typically presented in the user interface.
 * <p>
 * To present a context in the user interface a corresponding context
 * viewer can be registered via the extension point <code>
 * org.eclipse.ltk.ui.refactoring.statusContextViewers</code>.
 * </p>
 * <p>
 * This class may be subclassed by clients.
 * </p>
 *
 * @since 3.0
 */
public abstract class RefactoringStatusContext {
	
Returns the element that corresponds directly to this context,
or null if there is no corresponding element.


For example, the corresponding element of a context for a problem
detected in an IResource would be the resource itself.



Returns:the corresponding element
/**
	 * Returns the element that corresponds directly to this context,
	 * or <code>null</code> if there is no corresponding element.
	 * <p>
	 * For example, the corresponding element of a context for a problem
	 * detected in an <code>IResource</code> would be the resource itself.
	 * <p>
	 *
	 * @return the corresponding element
	 */
	public abstract Object getCorrespondingElement();

	/*
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		Object element= getCorrespondingElement();
		return element == null ? null : element.toString();
	}
}