Quick Assist Processor

Identifier:

org.eclipse.jdt.ui.quickAssistProcessors

Since:

3.0

Description:

This extension point allows to add a Quick Assist processor to offer new Quick Assists in the Java editor. This extension point supports the <enablement> element. The default variable is the containing org.eclipse.jdt.core.ICompilationUnit.
Defined variables for <with> expressions are:

"compilationUnit": type org.eclipse.jdt.core.ICompilationUnit; the compilation unit the quick assist is applied on (same as the default variable)
"projectNatures": type java.util.Collection<String>; all project natures of the current project
"sourceLevel": type java.lang.String; the source compliance level of the current project

Configuration Markup:

<!ELEMENT extension (quickAssistProcessor+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT quickAssistProcessor (enablement?)>

<!ATTLIST quickAssistProcessor

id CDATA #REQUIRED

name CDATA #IMPLIED

class CDATA #IMPLIED

requiredSourceLevel CDATA #IMPLIED>

id - a unique identifier for the Quick Assist processor
name - a localized name of the Quick Assist processor
class - the name of the class that implements this Quick Assist processor. The class must be public and implement org.eclipse.jdt.ui.text.java.IQuickAssistProcessor with a public 0-argument constructor.
requiredSourceLevel - an optional attribute to specify the minimal source compliance this processor requires

Examples:

The following is an example of a Quick Assist processor contribution:


 <extension point="org.eclipse.jdt.ui.quickAssistProcessors">
  <quickAssistProcessor
   id="AdvancedQuickAssistProcessor"
   name="Advanced Quick Assist Processor"
   requiredSourceLevel="1.5"  
   class="com.example.AdvancedQuickAssistProcessor">
  </quickAssistProcessor>
   <enablement>
      <with variable="projectNatures">
         <iterate operator="or">
            <equals value="org.eclipse.jdt.core.javanature"/>
         </iterate>
      </with>
   </enablement>
 </extension>

API Information:

The contributed class must implement org.eclipse.jdt.ui.text.java.IQuickAssistProcessor

Copyright (c) 2001, 2013 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-v20.html/ SPDX-License-Identifier: EPL-2.0