Add introspection functions to the README

scijava · ctrueden · Apr 29, 2025 · Mar 26, 2025 · Mar 27, 2025 · Mar 27, 2025
commit 553d552a4316ac0229fa3ea1f01cf014f54ad477
diff --git a/README.md b/README.md
@@ -283,6 +283,12 @@ FUNCTIONS
         You can pass a single integer to make a 1-dimensional array of that length.
         :return: The newly allocated array
 
+    java_source(data)
+        Try to find the source code using SciJava's SourceFinder.
+        :param data:
+            The object or class or fully qualified class name to check for source code.
+        :return: The URL of the java class
+
     jclass(data)
         Obtain a Java class object.
 
@@ -319,6 +325,14 @@ FUNCTIONS
         :param jtype: The Java type, as either a jimported class or as a string.
         :return: True iff the object is an instance of that Java type.
 
+    jreflect(data, aspect: str) -> List[Dict[str, Any]]
+        Use Java reflection to introspect the given Java object,
+        returning a table of its available methods or fields.
+
+        :param data: The object or class or fully qualified class name to inspect.
+        :param aspect: Either "methods" or "fields"
+        :return: List of dicts with keys: "name", "static", "arguments", and "returns".
+
     jstacktrace(exc) -> str
         Extract the Java-side stack trace from a Java exception.
 
@@ -427,6 +441,11 @@ FUNCTIONS
 
         :raise RuntimeError: if this method is called while in Jep mode.
 
+    src(data)
+        Print the source code URL for a Java class, object, or class name.
+
+        :param data: The Java class, object, or fully qualified class name as string
+
     start_jvm(options=None) -> None
         Explicitly connect to the Java virtual machine (JVM). Only one JVM can
         be active; does nothing if the JVM has already been started. Calling