Argus Codewatch Code Check

net.sourceforge.arguscodewatch.codeCheck

0.0.1

This extension points allows to register additional code checks which are subsequently triggered by Argus Codewatch. Additionally, each plugin can categorize its own code checks, either by referring to external categories, or by supplying its own category description.

<!ELEMENT extension (codeCheck+ | categoryName*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

Allows for additional code checks

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

<!ELEMENT codeCheck (option)*>

<!ATTLIST codeCheck

id CDATA #REQUIRED

defaultSeverity (WARNING|ERROR|IGNORE) "WARNING"

class CDATA #REQUIRED

categoryId CDATA #IMPLIED

description CDATA #REQUIRED

requiresBinding (true | false) "false">

All data about the code check should be published in this element. This includes the implementing class, and the problem description.

id - a unique name that will be used to identify this code check. This name is treated as fully qualified, i.e. the plugin id will not be prepended
defaultSeverity - defines the default action to be taken when a problem is recognized
class - the class that provides this code check. The class must be a subclass of org.eclipse.jdt.core.dom.ASTVisitor
categoryId - refers to the category id that this code check belongs to. This category id may be defined in a <markerGroupingEntry>, or may be a predefined category. If the referenced category does not exist, it is categorized under "miscellaneous"
description - provides the localized description of this element. This will be shown on the preferences page
requiresBinding - indicates whether this codeCheck depends on the ability to resolve bindings. This will cause the ASTParser to be created with resolveBindings set to true

<!ELEMENT option EMPTY>

<!ATTLIST option

id CDATA #REQUIRED

description CDATA #REQUIRED

type (boolean|string|visibility)

defaultValue CDATA #IMPLIED>

If the codeCheck requires additional settings, they may be specified here. They will be shown on the preferencePage, linked to the codeCheck.

id - a unique name that will be used to identify this option. This name is unqualified, and at initialization the name of the corresponding codeCheck will be prepended
description - provides the localized description of this element. This will be shown on the preferences page
type - specifies the type of option. Supported option types are boolean, (free-form) string and visibility options
defaultValue - the default value for this option. This default value is not checked for correctness (for example, you are allowed to specify "0" as default value for a boolean-type option)

<extension
      point=
"net.sourceforge.arguscodewatch.codeCheck"
>
   <codeCheck
         class=
"net.sourceforge.arguscodewatch.DummyCheck"

         id=
"dummyCheck"

         default_severity=
"WARNING"

         description=
"allow dummy code blocks"

         categoryId=
"net.sourceforge.arguscodewatch.category.dangerousCode"
>
     <option
           id=
"ignoreDuplicates"

           type=
"boolean"
/>
   </codeCheck>
</extension>

In this example, the class DummyCheck can query the value of its option via a call to parent.getProperty("dummyCheck.ignoreDuplicates"). This will return a String representation of Boolean.

The class must be a subclass of net.sourceforge.arguscodewatch.CodewatchVisitor. This abstract class extends ASTVisitor and adds a number of convenience methods. Like the ASTVisitor class, implementing classes only need to override the corresponding visit() methods. Markers can be easily created via the parent.createMarker() methods.

Unlike the ASTVisitor class, subclasses of CodewatchVisitor have access to the corresponding source code via the source field. Current preference settings can be obtained via the parent.getProperty() method.

Clients that want to implement additional preference settings, can use net.sourceforge.arguscodewatch.preferences as their page category.

All codeChecks in the original plug-in use this extension point.

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

Argus Codewatch Code Check

Identifier:

Since:

Description:

Configuration Markup:

Examples:

API Information:

Supplied Implementation: