Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.ltk.core.refactoring
Class RefactoringStatusContext  view RefactoringStatusContext download RefactoringStatusContext.java

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.RefactoringStatusContext
Direct Known Subclasses:
FileStatusContext

public abstract class RefactoringStatusContext
extends java.lang.Object

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

Constructor Summary
RefactoringStatusContext()
           
 
Method Summary
abstract  java.lang.Object getCorrespondingElement()
          Returns the element that corresponds directly to this context, or null if there is no corresponding element.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RefactoringStatusContext

public RefactoringStatusContext()
Method Detail

getCorrespondingElement

public abstract java.lang.Object getCorrespondingElement()
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 the the resource itself.


toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).