Analysis Details

Provide public access for every field used in the toString method

es.uniovi.reflection.analyses.bloch.3.10s

This rule detects classes that do not provide public getters to access fields which are used in expressions returned by the toString method.

Computational Reflection Research Group

12-03-2025 17:14

Bad Practice

Type Declaration

MATCH (field:ATTR_DEC{isUserCode:true})-[:USED_BY]->(expression)
WITH field, expression, es.uniovi.reflection.codeanalysis.functions.getEnclStmt(expression) as retStmt WHERE retStmt:RETURN_STATEMENT
MATCH (retStmt)-[:CFG_NEXT]->(:CFG_NORMAL_END)-[:CFG_END_OF]->(method:METHOD_DEC{name:'toString', actualType:'()java.lang.String', isUserCode:true})
WHERE NOT EXISTS ((field)-[:USED_BY]->()<-[:RETURN_EXPR]-()-[:CFG_NEXT]->(:CFG_NORMAL_END)-[:CFG_END_OF]->(:METHOD_DEC{accessLevel:'public'})) // Comprobamos que el field no tenga getter
WITH field,retStmt
MATCH (field)<-[:DECLARES_FIELD]-(typeDefinition)<-[:DECLARES_TYPE | HAS_NESTED_TYPE]-(enclosingCU:ORDINARY_CU)
WITH DISTINCT typeDefinition, enclosingCU, COLLECT(field) AS fields,retStmt
WITH typeDefinition, enclosingCU, REDUCE(s = HEAD(fields).name, n IN TAIL(fields) | s + ',' + n.name) as fields,retStmt
RETURN DISTINCT '{"node":"'+typeDefinition.fullyQualifiedName+'","line":"'+retStmt.lineNumber+'","column":"'+retStmt.column+'","rule":"BLOCH-3.10S","location":"'+enclosingCU.fileName+'","message":"You should provide a public getter to access the following fields ['+fields+'] in class '+ typeDefinition.fullyQualifiedName + ' in '+enclosingCU.fileName+', since they are used in the expression returned by the toString method (line '+retStmt.lineNumber+')"}'