Class ChangeCorrectionProposalCore
- java.lang.Object
-
- org.eclipse.jdt.core.manipulation.ChangeCorrectionProposalCore
-
- Direct Known Subclasses:
ChangeCorrectionProposal
,CUCorrectionProposalCore
public class ChangeCorrectionProposalCore extends Object
- Since:
- 1.11
-
-
Field Summary
Fields Modifier and Type Field Description protected Change
fChange
protected String
fName
protected int
fRelevance
-
Constructor Summary
Constructors Constructor Description ChangeCorrectionProposalCore(String name, Change change, int relevance)
Constructs a change correction proposal.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
apply()
protected Change
createChange()
Creates the change for this proposal.Object
getAdditionalProposalInfo(IProgressMonitor monitor)
Change
getChange()
Returns the change that will be executed when the proposal is applied.String
getName()
Returns the name of the proposal.int
getRelevance()
protected void
performChange()
Performs the change associated with this proposal.void
setDisplayName(String name)
Sets the display name.void
setRelevance(int relevance)
Sets the relevance.
-
-
-
Constructor Detail
-
ChangeCorrectionProposalCore
public ChangeCorrectionProposalCore(String name, Change change, int relevance)
Constructs a change correction proposal.- Parameters:
name
- the name that is displayed in the proposal selection dialogchange
- the change that is executed when the proposal is applied ornull
if the change will be created by implementors ofcreateChange()
relevance
- the relevance of this proposal
-
-
Method Detail
-
apply
public void apply() throws CoreException
- Throws:
CoreException
-
performChange
protected void performChange() throws CoreException
Performs the change associated with this proposal.Subclasses may extend, but must call the super implementation.
- Throws:
CoreException
- when the invocation of the change failed
-
getAdditionalProposalInfo
public Object getAdditionalProposalInfo(IProgressMonitor monitor)
-
getName
public String getName()
Returns the name of the proposal.- Returns:
- the name of the proposal
-
getChange
public Change getChange() throws CoreException
Returns the change that will be executed when the proposal is applied. This method callscreateChange()
to compute the change.- Returns:
- the change for this proposal, can be
null
in rare cases if creation of the change failed - Throws:
CoreException
- when the change could not be created
-
createChange
protected Change createChange() throws 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:
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:
getRelevance()
-
-