Class ASTRewriteCorrectionProposal

All Implemented Interfaces:
ICUCorrectionProposal, ICommandAccess, IJavaCompletionProposal, ICompletionProposal, ICompletionProposalExtension5, ICompletionProposalExtension6

public class ASTRewriteCorrectionProposal extends CUCorrectionProposal
A proposal for quick fixes and quick assists that works on an AST rewrite. Either a rewrite is directly passed in the constructor or the method getRewrite() is overridden to provide the AST rewrite that is evaluated on the document when the proposal is applied.
Since:
3.8
  • Constructor Details

    • ASTRewriteCorrectionProposal

      public ASTRewriteCorrectionProposal(String name, ICompilationUnit cu, ASTRewrite rewrite, int relevance, Image image, org.eclipse.jdt.ui.text.java.correction.ASTRewriteCorrectionProposalCore delegate)
      Constructs an AST rewrite correction proposal.
      Parameters:
      name - the display name of the proposal
      cu - the compilation unit that is modified
      rewrite - the AST rewrite that is invoked when the proposal is applied or null if getRewrite() is overridden
      relevance - the relevance of this proposal
      image - the image that is displayed for this proposal or null if no image is desired
      delegate - The delegate instance
      Since:
      3.31
    • ASTRewriteCorrectionProposal

      public ASTRewriteCorrectionProposal(String name, ICompilationUnit cu, ASTRewrite rewrite, int relevance, Image image)
      Constructs an AST rewrite correction proposal.
      Parameters:
      name - the display name of the proposal
      cu - the compilation unit that is modified
      rewrite - the AST rewrite that is invoked when the proposal is applied or null if getRewrite() is overridden
      relevance - the relevance of this proposal
      image - the image that is displayed for this proposal or null if no image is desired
    • ASTRewriteCorrectionProposal

      public ASTRewriteCorrectionProposal(String name, ICompilationUnit cu, ASTRewrite rewrite, int relevance)
      Constructs an AST rewrite correction proposal. Uses the default image for this proposal.
      Parameters:
      name - the display name of the proposal
      cu - the compilation unit that is modified
      rewrite - the AST rewrite that is invoked when the proposal is applied or null if getRewrite() is overridden
      relevance - The relevance of this proposal
  • Method Details

    • createImportRewrite

      public ImportRewrite createImportRewrite(CompilationUnit astRoot)
    • getRewrite

      protected ASTRewrite getRewrite() throws CoreException
      Throws:
      CoreException
    • getImportRewrite

      public ImportRewrite getImportRewrite()
      Returns the import rewrite used for this compilation unit.
      Returns:
      the import rewrite or null if no import rewrite has been set
      Restriction:
      This method is not intended to be re-implemented or extended by clients.
    • setImportRewrite

      public void setImportRewrite(ImportRewrite rewrite)
      Sets the import rewrite used for this compilation unit.
      Parameters:
      rewrite - the import rewrite
      Restriction:
      This method is not intended to be re-implemented or extended by clients.