Checklipse Default Configuration

de.mvmsoft.checkclipse.DefaultConfiguration

Checkclipse Version 2.0.0

Extension point to alter the default configuration of the Checkclipse plug-in.

<!ELEMENT extension (ChecksXml? , FileFilter? , UseProjectClassloader? , AutoBuild? , AddRuleToMessage? , ProjectBaseDir?)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT ChecksXml EMPTY>

<!ATTLIST ChecksXml

filename CDATA #REQUIRED

propertiesFile CDATA #IMPLIED>

Checkstyle configutration files (checks and properties).

filename - The Checkstyle checks configuration file.
propertiesFile - A property file needed to use the checks configuration. Optional.

<!ELEMENT FileFilter (FileFilterEntry+)>

<!ATTLIST FileFilter

srcDirOnly (true | false) "true">

Parent for file filter entries.

srcDirOnly - Only check files in the source directory? The plugin default value is "true".

<!ELEMENT FileFilterEntry EMPTY>

<!ATTLIST FileFilterEntry

type (include|exclude)

expression CDATA #REQUIRED>

A file filter entry. The plugin default value is: {include: "\.java$"}, {include: "\.properties$"}

type - Include or exclude the files matching expression?
expression - A regular expression used to match against the filename. See JavaDoc of java.util.regex.Pattern for a description of the supported regular expression syntax.

<!ELEMENT UseProjectClassloader EMPTY>

<!ATTLIST UseProjectClassloader

value (true | false) >

Should the project classpath be handed to Checkclipse to load classes from the project? Some checks need to load classes from the project. I don't see any reason to set this to "false". The plugin default value is "true".

value - Boolean: "true" or "false"

<!ELEMENT AutoBuild EMPTY>

<!ATTLIST AutoBuild

value (true | false) >

Should a build be run if the configuration changes? Recommended! The plugin default value is "true".

value - Boolean: "true" or "false"

<!ELEMENT AddRuleToMessage EMPTY>

<!ATTLIST AddRuleToMessage

value (true | false) >

Should the name of the Checkstyle rule be appended to the violation message? The plugin default value is "true".

value - Boolean: "true" or "false"

<!ELEMENT ProjectBaseDir EMPTY>

<!ATTLIST ProjectBaseDir

value (true | false) >

Use the project directory as the checkclipse basedir? The plugin default value is "true".

value - Boolean: "true" or "false"

The following is an example of this extension point:

<extension
  id=
"JoDoesCustomConfig"

  name=
"Jo Does Custom Confinguration"

  point=
"de.mvmsoft.checkclipse.CheckclipseDefaultConfiguration"
>
  <ChecksXml filename=
"config/sun_checks.xml"
/>
  <FileFilter srcDirOnly=
"true"
>
    <FileFilterEntry
      expression=
"\.java$"

      type=
"include"
/>
    <FileFilterEntry
      expression=
"\.properties$"

      type=
"include"
/>
    <FileFilterEntry
      expression=
"\.Ralf$"

      type=
"include"
/>
  </FileFilter>
</extension>

None, as this extension is only used for configurating values. No classes have to be implemented.

There is no supplied implementation.

Version: MPL 1.1

The contents of this file are subject to the Mozilla Public License Version
1.1 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.mozilla.org/MPL/

Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the
License.

The Original Code is a extension point description for Checkclipse.

The Initial Developer of the Original Code is Ralf Schandl.

Portions created by the Initial Developer are Copyright (C) 2006
the Initial Developer. All Rights Reserved.

Contributor(s):

Checklipse Default Configuration

Identifier:

Since:

Description:

Configuration Markup:

Examples:

API Information:

Supplied Implementation: