resources.report.rules.pmd.BooleanGetMethodName.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sanity4j Show documentation

Sanity4J was created to simplify running multiple static code analysis tools on the Java projects. It provides a single entry point to run all the selected tools and produce a consolidated report, which presents all findings in an easily accessible manner.

The newest version!



BooleanGetMethodName


BooleanGetMethodName
Looks for methods named 'getX()' with 'boolean' as the return type. The convention
is to name these methods 'isX()'.
        
		
		
		    
    			This rule is defined by the following XPath expression:
    			
    			
                        
//MethodDeclaration[
MethodDeclarator[count(FormalParameters/FormalParameter) = 0 or $checkParameterizedMethods = 'true']
                [starts-with(@Image, 'get')]
and
ResultType/Type/PrimitiveType[@Image = 'boolean']
]

                
  
		    
		    
	    
	    
        
        
        Example:
            
                    
            
public boolean getFoo(); // bad
public boolean isFoo(); // ok
public boolean getFoo(boolean bar); // ok, unless checkParameterizedMethods=true
     
            
  
        

        
        
            
                This rule has the following properties:
                Name Default value Description
                
                
                    

                    checkParameterizedMethods