Class CUCorrectionProposalCore
- java.lang.Object
-
- org.eclipse.jdt.core.manipulation.ChangeCorrectionProposalCore
-
- org.eclipse.jdt.core.manipulation.CUCorrectionProposalCore
-
- All Implemented Interfaces:
ICUCorrectionProposal
public class CUCorrectionProposalCore extends ChangeCorrectionProposalCore implements ICUCorrectionProposal
A proposal for quick fixes and quick assists that work on a single compilation unit. Either atext change
is directly passed in the constructor or methodaddEdits(IDocument, TextEdit)
is overridden to provide the text edits that are applied to the document when the proposal is evaluated.The proposal takes care of the preview of the changes as proposal information.
- Since:
- 1.11
-
-
Field Summary
-
Fields inherited from class org.eclipse.jdt.core.manipulation.ChangeCorrectionProposalCore
fChange, fName, fRelevance
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CUCorrectionProposalCore(String name, ICompilationUnit cu, int relevance)
Constructs a correction proposal working on a compilation unit.CUCorrectionProposalCore(String name, ICompilationUnit cu, TextChange change, int relevance)
Constructs a correction proposal working on a compilation unit with a given text change.CUCorrectionProposalCore(ICUCorrectionProposal proposal, String name, ICompilationUnit cu, TextChange change, int relevance)
Constructs a correction proposal working on a compilation unit with a given text change.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addEdits(IDocument document, TextEdit editRoot)
Called when theCompilationUnitChange
is initialized.void
apply()
protected Change
createChange()
Creates the change for this proposal.TextChange
createTextChange()
Creates the text change for this proposal.Object
getAdditionalProposalInfo(IProgressMonitor monitor)
ICompilationUnit
getCompilationUnit()
The compilation unit on which the change works.TextChange
getNewChange()
String
getPreviewContent()
Creates a preview of the content of the compilation unit after applying the change.TextChange
getTextChange()
Returns the text change that is invoked when the change is applied.String
toString()
-
Methods inherited from class org.eclipse.jdt.core.manipulation.ChangeCorrectionProposalCore
getChange, getName, getRelevance, performChange, setDisplayName, setRelevance
-
-
-
-
Constructor Detail
-
CUCorrectionProposalCore
public CUCorrectionProposalCore(ICUCorrectionProposal proposal, String name, ICompilationUnit cu, TextChange change, int relevance)
Constructs a correction proposal working on a compilation unit with a given text change.- Parameters:
proposal
- ICUCorrectionProposal to usename
- the name that is displayed in the proposal selection dialogcu
- the compilation unit to which the change can be appliedchange
- the change that is executed when the proposal is applied ornull
if implementors overrideaddEdits(IDocument, TextEdit)
to provide the text edits orcreateTextChange()
to provide a text changerelevance
- the relevance of this proposal
-
CUCorrectionProposalCore
public CUCorrectionProposalCore(String name, ICompilationUnit cu, TextChange change, int relevance)
Constructs a correction proposal working on a compilation unit with a given text change.- Parameters:
name
- the name that is displayed in the proposal selection dialogcu
- the compilation unit to which the change can be appliedchange
- the change that is executed when the proposal is applied ornull
if implementors overrideaddEdits(IDocument, TextEdit)
to provide the text edits orcreateTextChange()
to provide a text changerelevance
- the relevance of this proposal
-
CUCorrectionProposalCore
protected CUCorrectionProposalCore(String name, ICompilationUnit cu, int relevance)
Constructs a correction proposal working on a compilation unit.Users have to override
addEdits(IDocument, TextEdit)
to provide the text edits orcreateTextChange()
to provide a text change.- Parameters:
name
- the name that is displayed in the proposal selection dialogcu
- the compilation unit on that the change worksrelevance
- the relevance of this proposal
-
-
Method Detail
-
addEdits
protected void addEdits(IDocument document, TextEdit editRoot) throws CoreException
Called when theCompilationUnitChange
is initialized. Subclasses can override to add text edits to the root edit of the change. Implementors must not access the proposal, e.g. not callChangeCorrectionProposalCore.getChange()
.The default implementation does not add any edits
- Parameters:
document
- content of the underlying compilation unit. To be accessed read only.editRoot
- The root edit to add all edits to- Throws:
CoreException
- can be thrown if adding the edits is failing.
-
getAdditionalProposalInfo
public Object getAdditionalProposalInfo(IProgressMonitor monitor)
- Overrides:
getAdditionalProposalInfo
in classChangeCorrectionProposalCore
-
apply
public void apply() throws CoreException
- Overrides:
apply
in classChangeCorrectionProposalCore
- Throws:
CoreException
-
getNewChange
public TextChange getNewChange()
-
createTextChange
public TextChange createTextChange() throws CoreException
Creates the text change for this proposal. This method is only called once and only when no text change has been passed in {see #CUCorrectionProposal(String, ICompilationUnit, TextChange, int, Image)}.- Returns:
- the created text change
- Throws:
CoreException
- if the creation of the text change failed
-
createChange
protected Change createChange() throws CoreException
Description copied from class:ChangeCorrectionProposalCore
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.- Overrides:
createChange
in classChangeCorrectionProposalCore
- Returns:
- the created change
- Throws:
CoreException
- if the creation of the change failed
-
getTextChange
public final TextChange getTextChange() throws CoreException
Returns the text change that is invoked when the change is applied.- Specified by:
getTextChange
in interfaceICUCorrectionProposal
- Returns:
- the text change that is invoked when the change is applied
- Throws:
CoreException
- if accessing the change failed
-
getCompilationUnit
public ICompilationUnit getCompilationUnit()
The compilation unit on which the change works.- Returns:
- the compilation unit on which the change works
-
getPreviewContent
public String getPreviewContent() throws CoreException
Creates a preview of the content of the compilation unit after applying the change.- Returns:
- the preview of the changed compilation unit
- Throws:
CoreException
- if the creation of the change failed- Restriction:
- This method is not intended to be referenced by clients.
-
-