net.sourceforge.pmd

Class AbstractLanguageVersionTest

java.lang.Object

net.sourceforge.pmd.AbstractLanguageVersionTest

public class AbstractLanguageVersionTest
extends java.lang.Object

Base test class for LanguageVersion implementations.
Each language implementation should subclass this and provide a data method.

 @Parameters
     public static Collection<Object[]> data() {
       return Arrays.asList(new Object[][] {
            { MyLanguageModule.NAME, MyLanguageModule.TERSE_NAME, "1.1",
              LanguageRegistry.getLanguage(MyLanguageModule.NAME).getVersion("1.1") },
            { MyLanguageModule.NAME, MyLanguageModule.TERSE_NAME, "1.2",
              LanguageRegistry.getLanguage(MyLanguageModule.NAME).getVersion("1.2") },

            // doesn't exist
            { MyLanguageModule.NAME, MyLanguageModule.TERSE_NAME, "1.3",
              null }
       });
 

For the parameters, see the constructor AbstractLanguageVersionTest(String, String, String, LanguageVersion).

Constructor Summary

Constructors

Constructor and Description
AbstractLanguageVersionTest(java.lang.String name, java.lang.String terseName, java.lang.String version, LanguageVersion expected) Creates a new AbstractLanguageVersionTest

Method Summary

Modifier and Type	Method and Description
void	testFindVersionsForLanguageNameAndVersion() Checks that the expected LanguageVersion can be found via name and version.
void	testGetLanguageVersionForTerseName() Checks that the expected LanguageVersion can be found by the combination of terseName and version.
void	testRegisteredRulesets() Makes sure, that for each language a "rulesets.properties" file exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractLanguageVersionTest

public AbstractLanguageVersionTest(java.lang.String name,
                                   java.lang.String terseName,
                                   java.lang.String version,
                                   LanguageVersion expected)

Creates a new AbstractLanguageVersionTest

Parameters:

name - the name under which the language module is registered

terseName - the terse name under which the language module is registered

version - the specific version of the language version

expected - the expected LanguageVersion instance

Method Detail

testGetLanguageVersionForTerseName

public void testGetLanguageVersionForTerseName()

Checks that the expected LanguageVersion can be found by the combination of terseName and version.

testFindVersionsForLanguageNameAndVersion

public void testFindVersionsForLanguageNameAndVersion()

Checks that the expected LanguageVersion can be found via name and version.

testRegisteredRulesets

public void testRegisteredRulesets()
                            throws java.lang.Exception

Makes sure, that for each language a "rulesets.properties" file exists.

Throws:

java.lang.Exception - any error