groovy-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jwagenleit...@apache.org
Subject [2/2] groovy git commit: Fix groovydoc processPropertiesFromGetterSetter build exceptions
Date Mon, 25 Jan 2016 20:04:27 GMT
Fix groovydoc processPropertiesFromGetterSetter build exceptions

Fixes StringIndexOutOfBoundsException if method name was exactly named [set/get/is] with no
property name or NPE if classDoc was null.


Project: http://git-wip-us.apache.org/repos/asf/groovy/repo
Commit: http://git-wip-us.apache.org/repos/asf/groovy/commit/2e7c69dc
Tree: http://git-wip-us.apache.org/repos/asf/groovy/tree/2e7c69dc
Diff: http://git-wip-us.apache.org/repos/asf/groovy/diff/2e7c69dc

Branch: refs/heads/master
Commit: 2e7c69dc4d185dc790b7d15857235458ef3eb7a6
Parents: 57cb5e8
Author: John Wagenleitner <jwagenleitner@apache.org>
Authored: Mon Jan 25 11:02:10 2016 -0800
Committer: John Wagenleitner <jwagenleitner@apache.org>
Committed: Mon Jan 25 11:57:52 2016 -0800

----------------------------------------------------------------------
 .../SimpleGroovyClassDocAssembler.java          | 86 +++++++++++---------
 1 file changed, 48 insertions(+), 38 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/groovy/blob/2e7c69dc/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyClassDocAssembler.java
----------------------------------------------------------------------
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyClassDocAssembler.java
b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyClassDocAssembler.java
index cb9461d..44ded6b 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyClassDocAssembler.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyClassDocAssembler.java
@@ -268,51 +268,61 @@ public class SimpleGroovyClassDocAssembler extends VisitorAdapter implements
Gro
 
     private void processPropertiesFromGetterSetter(SimpleGroovyMethodDoc currentMethodDoc)
{
         String methodName = currentMethodDoc.name();
+        int len = methodName.length();
+        String prefix = null;
+        String propName = null;
+        if (len > 3 && methodName.startsWith("get")) {
+            prefix = "get";
+            propName = methodName.substring(3);
+        } else if (len > 3 && methodName.startsWith("set")) {
+            prefix = "set";
+            propName = methodName.substring(3);
+        } else if (len > 2 && methodName.startsWith("is")) {
+            prefix = "is";
+            propName = methodName.substring(2);
+        } else {
+            // Not a (get/set/is) method that contains a property name
+            return;
+        }
+
         SimpleGroovyClassDoc classDoc = getCurrentClassDoc();
+        // TODO: not sure why but groovy.ui.view.BasicContentPane#buildOutputArea classDoc
is null
+        if (classDoc == null) {
+            return;
+        }
         GroovyMethodDoc methods[] = classDoc.methods();
 
-        String setOrGet = methodName.substring(0, Math.min(methodName.length(), 3));
-        if (setOrGet.equals("set") || setOrGet.equals("get") || setOrGet.startsWith("is"))
{
-
-            //find expected method name
-            String expectedMethodName = null ;
-            if (setOrGet.equals("set") && (currentMethodDoc.parameters().length >=
1 && !currentMethodDoc.parameters()[0].typeName().equals("boolean"))) {
-                expectedMethodName = "get" + methodName.substring(3);
-            } else if (setOrGet.equals("get") && !currentMethodDoc.returnType().typeName().equals("boolean"))
{
-                expectedMethodName = "set" + methodName.substring(3);
-            } else if (setOrGet.startsWith("is")) {
-                expectedMethodName = "set" + methodName.substring(2);
-            } else {
-                expectedMethodName = "is" + methodName.substring(3);
-            }
-
-            for (GroovyMethodDoc methodDoc : methods) {
-                if (methodDoc.name().equals(expectedMethodName)) {
+        //find expected method name
+        String expectedMethodName = null;
+        if ("set".equals(prefix) && (currentMethodDoc.parameters().length >= 1
&& !currentMethodDoc.parameters()[0].typeName().equals("boolean"))) {
+            expectedMethodName = "get" + propName;
+        } else if ("get".equals(prefix) && !currentMethodDoc.returnType().typeName().equals("boolean"))
{
+            expectedMethodName = "set" + propName;
+        } else if ("is".equals(prefix)) {
+            expectedMethodName = "set" + propName;
+        } else {
+            expectedMethodName = "is" + propName;
+        }
 
-                    //extract the field name
-                    String fieldName = null;
-                    if (expectedMethodName.startsWith("set") && methodName.startsWith("is"))
{
-                        fieldName = methodName.substring(2);
-                    } else {
-                        fieldName = methodName.substring(3);
-                    }
+        for (GroovyMethodDoc methodDoc : methods) {
+            if (methodDoc.name().equals(expectedMethodName)) {
 
-                    fieldName = fieldName.substring(0, 1).toLowerCase() + fieldName.substring(1);
-                    SimpleGroovyFieldDoc currentFieldDoc = new SimpleGroovyFieldDoc(fieldName,
classDoc);
+                //extract the field name
+                String fieldName = propName.substring(0, 1).toLowerCase() + propName.substring(1);
+                SimpleGroovyFieldDoc currentFieldDoc = new SimpleGroovyFieldDoc(fieldName,
classDoc);
 
-                    //find the type of the field; if it's a setter, need to get the type
of the params
-                    if(expectedMethodName.startsWith("set") && methodDoc.parameters().length
>= 1) {
-                        String typeName = methodDoc.parameters()[0].typeName();
-                        currentFieldDoc.setType(new SimpleGroovyType(typeName));
-                    } else {
-                        //if it's not setter, get the type info of the return type of the
get* method
-                        currentFieldDoc.setType(methodDoc.returnType());
-                    }
+                //find the type of the field; if it's a setter, need to get the type of the
params
+                if(expectedMethodName.startsWith("set") && methodDoc.parameters().length
>= 1) {
+                    String typeName = methodDoc.parameters()[0].typeName();
+                    currentFieldDoc.setType(new SimpleGroovyType(typeName));
+                } else {
+                    //if it's not setter, get the type info of the return type of the get*
method
+                    currentFieldDoc.setType(methodDoc.returnType());
+                }
 
-                    if (methodDoc.isPublic() && currentMethodDoc.isPublic()) {
-                        classDoc.addProperty(currentFieldDoc);
-                        break;
-                    }
+                if (methodDoc.isPublic() && currentMethodDoc.isPublic()) {
+                    classDoc.addProperty(currentFieldDoc);
+                    break;
                 }
             }
         }


Mime
View raw message