blob: 7daded750d50870cc0fa8072821cc4465cfe9366 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
/*******************************************************************************
* Copyright (c) 2006, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.quickassist;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.source.Annotation;
/**
* Quick assist processor for quick fixes and quick assists.
* <p>
* A processor can provide just quick fixes, just quick assists
* or both.
* </p>
* <p>
* This interface can be implemented by clients.</p>
*
* @since 3.2
*/
public interface IQuickAssistProcessor {
/**
* Returns the reason why this quick assist processor
* was unable to produce any completion proposals.
*
* @return an error message or <code>null</code> if no error occurred
*/
String getErrorMessage();
/**
* Tells whether this processor has a fix for the given annotation.
* <p>
* <strong>Note:</strong> This test must be fast and optimistic i.e. it is OK to return
* <code>true</code> even though there might be no quick fix.
* </p>
*
* @param annotation the annotation
* @return <code>true</code> if the assistant has a fix for the given annotation
*/
boolean canFix(Annotation annotation);
/**
* Tells whether this assistant has assists for the given invocation context.
*
* @param invocationContext the invocation context
* @return <code>true</code> if the assistant has a fix for the given annotation
*/
boolean canAssist(IQuickAssistInvocationContext invocationContext);
/**
* Returns a list of quick assist and quick fix proposals for the
* given invocation context.
*
* @param invocationContext the invocation context
* @return an array of completion proposals or <code>null</code> if no proposals are available
*/
ICompletionProposal[] computeQuickAssistProposals(IQuickAssistInvocationContext invocationContext);
}
|
