Package org.machanism.machai.gw.maven.tools

Class ClassFunctionalTools

java.lang.Object
org.machanism.machai.gw.maven.tools.ClassFunctionalTools
All Implemented Interfaces:
org.machanism.machai.ai.tools.FunctionTools
public class ClassFunctionalTools extends Object implements org.machanism.machai.ai.tools.FunctionTools
Provides function-tool integrations for discovering Java classes and reading reflective metadata from the classpath of one or more Maven projects.

Instances maintain a cache of ClassInfoHolder objects keyed by Maven project base directory, allowing tool invocations to resolve classes relative to the current working project.

  • Field Details

    • FT_NOT_SUPPORTED_FOR_PROJECT_MSG

      private static final String FT_NOT_SUPPORTED_FOR_PROJECT_MSG
      Message returned when a tool call is made for a project that has not been scanned and registered in this instance.
      See Also:

    • CLASS_NAME_PROPERTY

      private static final String CLASS_NAME_PROPERTY
      See Also:

    • MODIFIERS_PROPERTY

      private static final String MODIFIERS_PROPERTY
      See Also:

    • classInfoProjectMap

      private Map<File,ClassInfoHolder> classInfoProjectMap
      Holds class metadata by Maven project base directory.

  • Constructor Details

    • ClassFunctionalTools

      public ClassFunctionalTools(org.apache.maven.project.MavenProject project)
      Creates a new instance backed by the supplied Maven project's classpath.
      Parameters:
      project - the Maven project used to resolve classpath and output directories

    • ClassFunctionalTools

      public ClassFunctionalTools()
      Creates an empty instance. Projects must be registered later through scanProjectClasses(MavenProject) before tool invocations can resolve class information.

  • Method Details

    • scanProjectClasses

      public void scanProjectClasses(org.apache.maven.project.MavenProject project)
      Registers a project by scanning and caching class metadata for its base directory.
      Parameters:
      project - the Maven project to register

    • findClass

      public String findClass(String className, File projectDir)
      Finds fully qualified class names whose simple names match the supplied regular expression.

    • getClassInfo

      public Map<String,Object> getClassInfo(String className, File projectDir) throws ClassNotFoundException
      Returns reflective information for the specified class.

      The generated output may include modifiers, superclass, interfaces, non-private fields, constructors, non-private methods, annotations, class path, and dependency artifact coordinates.

      Parameters:
      className - fully qualified class name to inspect
      projectDir - the Maven project base directory used to resolve class metadata
      Returns:
      a HashMap describing the requested class or containing an error property when the class or project context cannot be resolved
      Throws:
      ClassNotFoundException

    • populateClassInfo

      private Map<String,Object> populateClassInfo(ClassInfoHolder classInfoHolder, String className, Class<?> clazz)

    • addSuperclass

      private void addSuperclass(Map<String,Object> info, Class<?> clazz)

    • addInterfaces

      private void addInterfaces(Map<String,Object> info, Class<?> clazz)

    • addFields

      private void addFields(Map<String,Object> info, Class<?> clazz)

    • addConstructors

      private void addConstructors(Map<String,Object> info, Class<?> clazz)

    • addMethods

      private void addMethods(Map<String,Object> info, Class<?> clazz)

    • addAnnotations

      private void addAnnotations(Map<String,Object> info, Class<?> clazz)

    • addLocationMetadata

      private void addLocationMetadata(Map<String,Object> info, ClassInfoHolder classInfoHolder, String className)

    • toParameterTypes

      private List<String> toParameterTypes(Class<?>[] parameterTypes)

    • forEachNonPrivate

      private <T extends Member> void forEachNonPrivate(T[] members, Consumer<T> consumer)