Expose getTypeDescriptorStr() and getTypeSignatureStr() (#380)

lukehutch · lukehutch · commit 0538be3f3885 · 2019-11-03T18:11:09.000-07:00
diff --git a/src/main/java/io/github/classgraph/ClassInfo.java b/src/main/java/io/github/classgraph/ClassInfo.java
@@ -2455,9 +2455,10 @@ ClassInfoList getClassesWithFieldAnnotationDirectOnly() {
     // -------------------------------------------------------------------------------------------------------------
 
     /**
-     * Get the type signature of the class.
+     * Get the parsed type signature for the class.
      *
-     * @return The class type signature, if available, otherwise returns null.
+     * @return The parsed type signature for the class, including any generic type parameters, or null if not
+     *         available (probably indicating the class is not generic).
      */
     public ClassTypeSignature getTypeSignature() {
         if (typeSignatureStr == null) {
@@ -2474,6 +2475,16 @@ public ClassTypeSignature getTypeSignature() {
         return typeSignature;
     }
 
+    /**
+     * Get the type signature string for the class.
+     *
+     * @return The type signature string for the class, including any generic type parameters, or null if not
+     *         available (probably indicating the class is not generic).
+     */
+    public String getTypeSignatureStr() {
+        return typeSignatureStr;
+    }
+
     // -------------------------------------------------------------------------------------------------------------
 
     /**
diff --git a/src/main/java/io/github/classgraph/FieldInfo.java b/src/main/java/io/github/classgraph/FieldInfo.java
@@ -197,9 +197,10 @@ public int getModifiers() {
     }
 
     /**
-     * Returns the parsed type descriptor for the field, if available.
+     * Returns the parsed type descriptor for the field, which will not include type parameters. If you need generic
+     * type parameters, call {@link #getTypeSignature()} instead.
      * 
-     * @return The parsed type descriptor for the field, if available, else returns null.
+     * @return The parsed type descriptor string for the field.
      */
     public TypeSignature getTypeDescriptor() {
         if (typeDescriptorStr == null) {
@@ -217,9 +218,21 @@ public TypeSignature getTypeDescriptor() {
     }
 
     /**
-     * Returns the parsed type signature for the field, if available.
+     * Returns the type descriptor string for the field, which will not include type parameters. If you need generic
+     * type parameters, call {@link #getTypeSignatureStr()} instead.
      * 
-     * @return The parsed type signature for the field, if available, else returns null.
+     * @return The type descriptor string for the field.
+     */
+    public String getTypeDescriptorStr() {
+        return typeDescriptorStr;
+    }
+
+    /**
+     * Returns the parsed type signature for the field, possibly including type parameters. If this returns null,
+     * indicating that no type signature information is available for this field, call {@link #getTypeDescriptor()}
+     * instead.
+     * 
+     * @return The parsed type signature for the field, or null if not available.
      */
     public TypeSignature getTypeSignature() {
         if (typeSignatureStr == null) {
@@ -236,6 +249,17 @@ public TypeSignature getTypeSignature() {
         return typeSignature;
     }
 
+    /**
+     * Returns the type signature string for the field, possibly including type parameters. If this returns null,
+     * indicating that no type signature information is available for this field, call
+     * {@link #getTypeDescriptorStr()} instead.
+     * 
+     * @return The type signature string for the field, or null if not available.
+     */
+    public String getTypeSignatureStr() {
+        return typeSignatureStr;
+    }
+
     /**
      * Returns the type signature for the field, possibly including type parameters. If the type signature is null,
      * indicating that no type signature information is available for this field, returns the type descriptor
@@ -253,6 +277,22 @@ public TypeSignature getTypeSignatureOrTypeDescriptor() {
         }
     }
 
+    /**
+     * Returns the type signature string for the field, possibly including type parameters. If the type signature
+     * string is null, indicating that no type signature information is available for this field, returns the type
+     * descriptor string instead.
+     * 
+     * @return The type signature string for the field, or if not available, the type descriptor string for the
+     *         method.
+     */
+    public String getTypeSignatureOrTypeDescriptorStr() {
+        if (typeSignatureStr != null) {
+            return typeSignatureStr;
+        } else {
+            return typeDescriptorStr;
+        }
+    }
+
     /**
      * Returns the constant initializer value of a constant final field. Requires
      * {@link ClassGraph#enableStaticFinalFieldConstantInitializerValues()} to have been called.
diff --git a/src/main/java/io/github/classgraph/MethodInfo.java b/src/main/java/io/github/classgraph/MethodInfo.java
@@ -192,7 +192,7 @@ public ClassInfo getClassInfo() {
 
     /**
      * Returns the parsed type descriptor for the method, which will not include type parameters. If you need
-     * generic type parameters, call getTypeSignature() instead.
+     * generic type parameters, call {@link #getTypeSignature()} instead.
      * 
      * @return The parsed type descriptor for the method.
      */
@@ -208,9 +208,20 @@ public MethodTypeSignature getTypeDescriptor() {
         return typeDescriptor;
     }
 
+    /**
+     * Returns the type descriptor string for the method, which will not include type parameters. If you need
+     * generic type parameters, call {@link #getTypeSignatureStr()} instead.
+     * 
+     * @return The type descriptor string for the method.
+     */
+    public String getTypeDescriptorStr() {
+        return typeDescriptorStr;
+    }
+
     /**
      * Returns the parsed type signature for the method, possibly including type parameters. If this returns null,
-     * indicating that no type signature information is available for this method, call getTypeDescriptor() instead.
+     * indicating that no type signature information is available for this method, call {@link #getTypeDescriptor()}
+     * instead.
      * 
      * @return The parsed type signature for the method, or null if not available.
      */
@@ -227,8 +238,19 @@ public MethodTypeSignature getTypeSignature() {
     }
 
     /**
-     * Returns the parsed type signature for the method, possibly including type parameters. If the parsed type
-     * signature is null, indicating that no type signature information is available for this method, returns the
+     * Returns the type signature string for the method, possibly including type parameters. If this returns null,
+     * indicating that no type signature information is available for this method, call
+     * {@link #getTypeDescriptorStr()} instead.
+     * 
+     * @return The type signature string for the method, or null if not available.
+     */
+    public String getTypeSignatureStr() {
+        return typeSignatureStr;
+    }
+
+    /**
+     * Returns the parsed type signature for the method, possibly including type parameters. If the type signature
+     * string is null, indicating that no type signature information is available for this method, returns the
      * parsed type descriptor instead.
      * 
      * @return The parsed type signature for the method, or if not available, the parsed type descriptor for the
@@ -243,6 +265,22 @@ public MethodTypeSignature getTypeSignatureOrTypeDescriptor() {
         }
     }
 
+    /**
+     * Returns the type signature string for the method, possibly including type parameters. If the type signature
+     * string is null, indicating that no type signature information is available for this method, returns the type
+     * descriptor string instead.
+     * 
+     * @return The type signature string for the method, or if not available, the type descriptor string for the
+     *         method.
+     */
+    public String getTypeSignatureOrTypeDescriptorStr() {
+        if (typeSignatureStr != null) {
+            return typeSignatureStr;
+        } else {
+            return typeDescriptorStr;
+        }
+    }
+
     // -------------------------------------------------------------------------------------------------------------
 
     /**
