org.eclipse.wst.jsdt.ui.text.java
Interface IJavadocCompletionProcessor


public interface IJavadocCompletionProcessor

A Javadoc processor proposes completions and computes context information for a particular content type.

This interface must be implemented by clients who extend the org.eclipse.wst.jsdt.ui.javadocCompletionProcessor extension-point

. Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Field Summary
static int RESTRICT_TO_MATCHING_CASE
          Flag used by computeCompletionProposals.
 
Method Summary
 IJavaCompletionProposal[] computeCompletionProposals(IJavaScriptUnit cu, int offset, int length, int flags)
          Returns the completion proposals based on the specified location within the compilation unit.
 IContextInformation[] computeContextInformation(IJavaScriptUnit cu, int offset)
          Returns information about possible contexts based on the specified location within the compilation unit.
 java.lang.String getErrorMessage()
          Returns the reason why this completion processor was unable to produce a completion proposals or context information.
 

Field Detail

RESTRICT_TO_MATCHING_CASE

static final int RESTRICT_TO_MATCHING_CASE
Flag used by computeCompletionProposals. Specifies that only proposals should be returned that match the case of the prefix in the code (value: 1).

See Also:
Constant Field Values
Method Detail

computeContextInformation

IContextInformation[] computeContextInformation(IJavaScriptUnit cu,
                                                int offset)
Returns information about possible contexts based on the specified location within the compilation unit.

Parameters:
cu - the working copy of the compilation unit which is used to compute the possible contexts
offset - an offset within the compilation unit for which context information should be computed
Returns:
an array of context information objects or null if no context could be found

computeCompletionProposals

IJavaCompletionProposal[] computeCompletionProposals(IJavaScriptUnit cu,
                                                     int offset,
                                                     int length,
                                                     int flags)
Returns the completion proposals based on the specified location within the compilation unit.

Parameters:
cu - the working copy of the compilation unit in which the completion request has been called.
offset - an offset within the compilation unit for which completion proposals should be computed
length - the length of the current selection.
flags - settings for the code assist. Flags as defined in this interface, e.g. RESTRICT_TO_MATCHING_CASE.
Returns:
an array of completion proposals or null if no proposals could be found

getErrorMessage

java.lang.String getErrorMessage()
Returns the reason why this completion processor was unable to produce a completion proposals or context information.

Returns:
an error message or null if no error occurred