hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Adding a new rule : GenericsNaming

Browse Source 
Thanks to Nicolas Dordet for his inputs on this one.

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/branches/pmd/4.2.x@7009 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Romain Pelisse 2009-12-04 13:37:26 +00:00
parent d836721675
commit 59eaa27c59
4 changed files with 98 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
pmd/etc/changelog.txt
View File

@ -21,6 +21,7 @@ New rule:
Android: DoNotHardCodeSDCard
Controversial : AvoidLiteralsInIfCondition (patch 2591627), UseConcurrentHashMap
StrictExceptions : AvoidCatchingGenericException, AvoidLosingExceptionInformation
Naming : GenericsNaming
February 08, 2009 - 4.2.5:

1
pmd/regress/test/net/sourceforge/pmd/rules/naming/NamingRulesTest.java
View File

@ -26,6 +26,7 @@ public class NamingRulesTest extends SimpleAggregatorTst {
addRule("naming", "SuspiciousEqualsMethodName");
addRule("naming", "SuspiciousHashcodeMethodName");
addRule("naming", "VariableNamingConventions");
addRule("naming", "GenericsNaming");
}
public static junit.framework.Test suite() {

47
pmd/regress/test/net/sourceforge/pmd/rules/naming/xml/GenericsNaming.xml Normal file
View File

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="UTF-8"?>
<test-data>
<test-code>
<description><![CDATA[
1 upper case/single letter
]]></description>
<expected-problems>0</expected-problems>
<code><![CDATA[
public interface Foo <B extends Bar>
{
}
]]></code>
</test-code>
<test-code>
<description><![CDATA[
2 upper case/single letter
]]></description>
<expected-problems>0</expected-problems>
<code><![CDATA[
public interface Foo <B extends Bar, C extends Car>
{
}
]]></code>
</test-code>
<test-code>
<description><![CDATA[
1 lower Case/single letter
]]></description>
<expected-problems>1</expected-problems>
<code><![CDATA[
public interface Foo <b extends Bar>
{
}
]]></code>
</test-code>
<test-code>
<description><![CDATA[
1 lower case/multiple letter
]]></description>
<expected-problems>1</expected-problems>
<code><![CDATA[
public interface Foo <BA extends Bar>
{
}
]]></code>
</test-code>
</test-data>

49
pmd/rulesets/naming.xml
View File

@ -507,4 +507,53 @@ public boolean getFoo(boolean bar); // ok, unless checkParameterizedMethods=true
]]></example>
</rule>
<rule name="GenericsNaming"
since="4.2.6"
message="Generics names should be a one letter long and upper case."
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/naming.html#GenericsNaming">
<description>
Generics names should be a one letter long and upper case.
</description>
<priority>4</priority>
<properties>
<property name="xpath">
<value>
<![CDATA[
//TypeDeclaration/ClassOrInterfaceDeclaration/TypeParameters/TypeParameter[
string-length(@Image) > 1
or
string:upper-case(@Image) != @Image
]
]]>
</value>
</property>
</properties>
<example>
<![CDATA[
public interface GenericDao<E extends BaseModel, K extends Serializable> extends BaseDao
{
// This is ok...
}
public interface GenericDao<E extends BaseModel, K extends Serializable>
{
// Also this
}
public interface GenericDao<e extends BaseModel, K extends Serializable>
{
// 'e' should be an 'E'
}
public interface GenericDao<EF extends BaseModel, K extends Serializable>
{
// 'EF' is not ok.
}
]]></example>
</rule>
</ruleset>