Merge pull request #5805 from smowton/smowton/admin/spring-setter-method-docs

aschackmull · web-flow · commit 404a6c150640 · 2021-04-29T15:10:58.000+02:00
Document `SpringProperty::getSetterMethod`.
diff --git a/java/ql/src/semmle/code/java/frameworks/spring/SpringProperty.qll b/java/ql/src/semmle/code/java/frameworks/spring/SpringProperty.qll
@@ -69,11 +69,19 @@ class SpringProperty extends SpringXMLElement {
     )
   }
 
+  /**
+   * Gets a setter method declared on this property's enclosing bean that sets this property.
+   */
   Method getSetterMethod() {
     this.getEnclosingBean().getClass().hasMethod(result, _) and
     result.getName().toLowerCase() = "set" + this.getPropertyName().toLowerCase()
   }
 
+  /**
+   * Gets a setter method declared on bean `context` that sets this property.
+   *
+   * This property must be declared on a bean that is an ancestor of `context`.
+   */
   Method getSetterMethod(SpringBean context) {
     this.getEnclosingBean() = context.getBeanParent*() and
     context.getClass().hasMethod(result, _) and

Original file line number	Diff line number	Diff line change
`@@ -69,11 +69,19 @@ class SpringProperty extends SpringXMLElement {`
`69`	`69`	`)`
`70`	`70`	`}`
`71`	`71`
	`72`	`+ /**`
	`73`	`+ * Gets a setter method declared on this property's enclosing bean that sets this property.`
	`74`	`+ */`
`72`	`75`	`Method getSetterMethod() {`
`73`	`76`	`this.getEnclosingBean().getClass().hasMethod(result, _) and`
`74`	`77`	`result.getName().toLowerCase() = "set" + this.getPropertyName().toLowerCase()`
`75`	`78`	`}`
`76`	`79`
	`80`	`+ /**`
	`81`	+ * Gets a setter method declared on bean `context` that sets this property.
	`82`	`+ *`
	`83`	+ * This property must be declared on a bean that is an ancestor of `context`.
	`84`	`+ */`
`77`	`85`	`Method getSetterMethod(SpringBean context) {`
`78`	`86`	`this.getEnclosingBean() = context.getBeanParent*() and`
`79`	`87`	`context.getClass().hasMethod(result, _) and`