Interface IQuickAssistProcessor

  • All Known Implementing Classes:
    SpellingCorrectionProcessor

    public interface IQuickAssistProcessor
    Quick assist processor for quick fixes and quick assists.

    A processor can provide just quick fixes, just quick assists or both.

    This interface can be implemented by clients.

    Since:
    3.2
    • Method Detail

      • getErrorMessage

        String getErrorMessage()
        Returns the reason why this quick assist processor was unable to produce any completion proposals.
        Returns:
        an error message or null if no error occurred
      • canFix

        boolean canFix​(Annotation annotation)
        Tells whether this processor has a fix for the given annotation.

        Note: This test must be fast and optimistic i.e. it is OK to return true even though there might be no quick fix.

        Parameters:
        annotation - the annotation
        Returns:
        true if the assistant has a fix for the given annotation
      • canAssist

        boolean canAssist​(IQuickAssistInvocationContext invocationContext)
        Tells whether this assistant has assists for the given invocation context.
        Parameters:
        invocationContext - the invocation context
        Returns:
        true if the assistant has a fix for the given annotation
      • computeQuickAssistProposals

        ICompletionProposal[] computeQuickAssistProposals​(IQuickAssistInvocationContext invocationContext)
        Returns a list of quick assist and quick fix proposals for the given invocation context.
        Parameters:
        invocationContext - the invocation context
        Returns:
        an array of completion proposals or null if no proposals are available