resources.report.rules.pmd.LocalHomeNamingConvention.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!



LocalHomeNamingConvention


LocalHomeNamingConvention
The Local Home interface of a Session EJB should be suffixed by 'LocalHome'.
        
		
		
		    
    			This rule is defined by the following XPath expression:
    			
    			
                        
//ClassOrInterfaceDeclaration
[
    (
        (./ExtendsList/ClassOrInterfaceType[ends-with(@Image,'EJBLocalHome')])
    )
    and
    not
    (
        ends-with(@Image,'LocalHome')
    )
]
                    
                
  
		    
		    
	    
	    
        
        
        Example:
            
                    
            
            /* Proper name */
            public interface MyBeautifulLocalHome extends javax.ejb.EJBLocalHome {}
            
        
            
  
        
        Example:
            
                    
            
            /* Bad name */
            public interface MissingProperSuffix extends javax.ejb.EJBLocalHome {}