Argus Codewatch Quick fix

Identifier:

Since:

Description:

This extension point allows to add a quick fix to a previously defined code check.

Configuration Markup:

<!ELEMENT extension (quickFix)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

Allows for quick fixes to Argus code checks

• point - net.sourceforge.arguscodewatch.quickFix
• id - a unique name that can be used to identify this extension
• name - a translatable name of this extension

<!ELEMENT quickFix EMPTY>

<!ATTLIST quickFix

id          CDATA #REQUIRED

codeCheckId CDATA #REQUIRED

description CDATA #IMPLIED

class       CDATA #REQUIRED>

This element allows you to define new quickFixes.

• id - a unique name that can be used to identify this quickFix. This name is treated as fully qualified, i.e. the plugin id will not be prepended
• codeCheckId - refers to the codeCheck that this class provides quick fixes for
• description - provides the localized description of this element. This will be displayed in the QuickFix context menu
• class - the class that provides the quick fix. Must be a subclass of CodewatchCompletionProposal

Examples:

<extension
      point=
"net.sourceforge.arguscodewatch.quickFix"
>
   
<quickFix
         class=
"net.sourceforge.arguscodewatch.QuickFixBlock"

         codeCheckId=
"missingBraces"

         id=
"missingBraceFix"
/>
</extension>

API Information:

The class must be a subclass of net.sourceforge.arguscodewatch.CodewatchCompletionProposal. This abstract class implements IJavaCompletionProposal, and provides a stub implementation for most methods.

The class must at least implement the methods doBuildReplacement() and getRelevance(), and may override getSelection(), getAdditionalProposalInfo() and getDisplayString().

doBuildReplacement() can return its result in two ways: either by returning a TextEdit instance, or by returning null and setting a (non-null) replacement String via setReplacement(). In the latter case, clients must also provide valid range settings for the replacement. If both of these requirements are not met, no substitution is performed.

Supplied Implementation:

Copyright (C) 2005, TOP Informatie Systemen bv and others
All source is made available under the terms of the Eclipse Public License v1.0, a copy of which is available at http://www.eclipse.org/legal/epl-v10.html