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



RemoteInterfaceNamingConvention


RemoteInterfaceNamingConvention
Remote Interface of a Session EJB should NOT be suffixed.
        
		
		
		    
    			This rule is defined by the following XPath expression:
    			
    			
                        
//ClassOrInterfaceDeclaration
[
    (
        (./ExtendsList/ClassOrInterfaceType[ends-with(@Image,'EJBObject')])
    )
    and
    (
        ends-with(@Image,'Session')
        or
        ends-with(@Image,'EJB')
        or
        ends-with(@Image,'Bean')
    )
]
                    
                
  
		    
		    
	    
	    
        
        
        Example:
            
                    
            
            /* Bad Session suffix */
            public interface BadSuffixSession extends javax.ejb.EJBObject {}
            
        
            
  
        
        Example:
            
                    
            
            /* Bad EJB suffix */
            public interface BadSuffixEJB extends javax.ejb.EJBObject {}
            
        
            
  
        
        Example:
            
                    
            
            /* Bad Bean suffix */
            public interface BadSuffixBean extends javax.ejb.EJBObject {}