Package org.eclipse.jdt.core.manipulation

Class ChangeCorrectionProposalCore

java.lang.Object
org.eclipse.jdt.core.manipulation.ChangeCorrectionProposalCore
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable
Direct Known Subclasses:
ChangeCorrectionProposal, CUCorrectionProposalCore
public class ChangeCorrectionProposalCore extends Object implements org.eclipse.core.runtime.IAdaptable
Since:
1.11

  • Field Details

    • fChange

      protected org.eclipse.ltk.core.refactoring.Change fChange

    • fName

      protected String fName

    • fRelevance

      protected int fRelevance

  • Constructor Details

    • ChangeCorrectionProposalCore

      public ChangeCorrectionProposalCore(String name, org.eclipse.ltk.core.refactoring.Change change, int relevance)
      Constructs a change correction proposal.
      Parameters:
      name - the name that is displayed in the proposal selection dialog
      change - the change that is executed when the proposal is applied or null if the change will be created by implementors of createChange()
      relevance - the relevance of this proposal

  • Method Details

    • apply

      public void apply() throws org.eclipse.core.runtime.CoreException
      Throws:
      org.eclipse.core.runtime.CoreException

    • performChange

      protected void performChange() throws org.eclipse.core.runtime.CoreException
      Performs the change associated with this proposal.

      Subclasses may extend, but must call the super implementation.

      Throws:
      org.eclipse.core.runtime.CoreException - when the invocation of the change failed

    • getAdditionalProposalInfo

      public Object getAdditionalProposalInfo(org.eclipse.core.runtime.IProgressMonitor monitor)

    • getName

      public String getName()
      Returns the name of the proposal.
      Returns:
      the name of the proposal

    • getChange

      public org.eclipse.ltk.core.refactoring.Change getChange() throws org.eclipse.core.runtime.CoreException
      Returns the change that will be executed when the proposal is applied. This method calls createChange() to compute the change.
      Returns:
      the change for this proposal, can be null in rare cases if creation of the change failed
      Throws:
      org.eclipse.core.runtime.CoreException - when the change could not be created

    • getCurrentChange

      public org.eclipse.ltk.core.refactoring.Change getCurrentChange()
      Returns:
      The current change, or null if not initialized yet
      Since:
      1.20

    • createChange

      protected org.eclipse.ltk.core.refactoring.Change createChange() throws org.eclipse.core.runtime.CoreException
      Creates the change for this proposal. This method is only called once and only when no change has been passed in {#ChangeCorrectionProposal(String, Change, int, Image)}. Subclasses may override.
      Returns:
      the created change
      Throws:
      org.eclipse.core.runtime.CoreException - if the creation of the change failed

    • setDisplayName

      public void setDisplayName(String name)
      Sets the display name.
      Parameters:
      name - the name to set

    • getRelevance

      public int getRelevance()

    • setRelevance

      public void setRelevance(int relevance)
      Sets the relevance.
      Parameters:
      relevance - the relevance to set
      See Also:

    • getCommandId

      public String getCommandId()
      Returns:
      the command id
      Since:
      1.20

    • setCommandId

      public void setCommandId(String commandId)
      Set the proposal id to allow assigning a shortcut to the correction proposal.
      Parameters:
      commandId - The proposal id for this proposal or null if no command should be assigned to this proposal.
      Since:
      1.20

    • getAdapter

      public <T> T getAdapter(Class<T> adapter)
      Specified by:
      getAdapter in interface org.eclipse.core.runtime.IAdaptable