Index

A

AbstractActMojo - Class in org.machanism.machai.gw.maven

Abstract base Maven mojo for goals that execute Ghostwriter acts.

AbstractActMojo() - Constructor for class org.machanism.machai.gw.maven.AbstractActMojo

Creates an act mojo.

AbstractActPerModuleMojo - Class in org.machanism.machai.gw.maven

Base Maven mojo for acts that execute once for every eligible module in a Maven reactor.

AbstractActPerModuleMojo() - Constructor for class org.machanism.machai.gw.maven.AbstractActPerModuleMojo

 

AbstractGWMojo - Class in org.machanism.machai.gw.maven

Base class for Maven goals that scan project files for guidance comments and delegate processing to a GuidanceProcessor.

AbstractGWMojo() - Constructor for class org.machanism.machai.gw.maven.AbstractGWMojo

Creates the base mojo instance.

act - Variable in class org.machanism.machai.gw.maven.AbstractActMojo

Action prompt text or predefined act name, supplied by the gw.act Maven property.

ActMojo - Class in org.machanism.machai.gw.maven

Maven goal that executes a Ghostwriter act against project files.

ActMojo() - Constructor for class org.machanism.machai.gw.maven.ActMojo

 

ActPerModuleMojo - Class in org.machanism.machai.gw.maven

Maven goal gw:act-per-module that runs an action for an eligible project in Maven's standard reactor build context.

ActPerModuleMojo() - Constructor for class org.machanism.machai.gw.maven.ActPerModuleMojo

 

acts - Variable in class org.machanism.machai.gw.maven.AbstractActMojo

Optional directory, path, or URL containing predefined action definitions, supplied by the gw.acts Maven property.

addAnnotations(Map, Class) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Adds string representations of annotations declared directly on the class.

addConstructors(Map, Class) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Adds metadata for all declared constructors, including private constructors.

addDirectoryEntries(String, List) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Recursively adds compiled-class entries found beneath a directory.

addFields(Map, Class) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Adds metadata for declared fields that are not private.

addInterfaces(Map, Class) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Adds names of interfaces directly implemented by the class.

Additional inherited Maven parameters - Section in class org.machanism.machai.gw.maven.ActMojo

 

addJarEntries(File, List) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Adds all entries from a jar artifact to the supplied collection.

addLocationMetadata(Map, ClassInfoHolder, String) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Adds classpath, artifact, and project-source location metadata.

addMethods(Map, Class) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Adds metadata for declared methods that are not private.

addSuperclass(Map, Class) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Adds the class's direct superclass, when one exists.

applyActPrompt(Configurator) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Ensures an act prompt is stored in Maven user properties.

applyExcludes(AbstractFileProcessor) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Applies exclusion patterns from the processor configuration, falling back to the exclusions supplied directly to this mojo when the configuration does not define any.

Architecture and usage - Section in Overview

 

artifactMap - Variable in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Maps fully qualified class names to Maven artifact coordinates in the form groupId:artifactId:version when the class comes from a dependency.

B

basedir - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Maven module base directory injected from the ${basedir} expression.

C

CLASS_NAME_PROPERTY - Static variable in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

JSON property used for a class's fully qualified name.

Class diagram - Section in Overview

 

classes - Variable in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

All classes visible from the constructed project class loader.

ClassFunctionalTools - Class in org.machanism.machai.gw.maven.tools

Provides function-tool integrations for discovering Java classes and reading reflective metadata from the classpath of one or more Maven projects.

ClassFunctionalTools() - Constructor for class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Creates an empty instance.

ClassFunctionalTools(MavenProject) - Constructor for class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Creates a new instance backed by the supplied Maven project's classpath.

classFunctionTools - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Tool set exposed to the processor for class-related project introspection when Maven is executing with a project.

ClassInfoHolder - Class in org.machanism.machai.gw.maven.tools

Holds class discovery and lookup data for a single Maven project.

ClassInfoHolder(MavenProject) - Constructor for class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Creates a holder for the supplied Maven project and eagerly initializes class discovery metadata.

classInfoProjectMap - Variable in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Holds class metadata by Maven project base directory.

classLoader - Variable in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Class loader built from the Maven project classpath and output directories.

classPathMap - Variable in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Maps fully qualified class names to the filesystem path or jar path from which they were resolved.

configFile - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Optional configuration file loaded before Maven server and explicit parameter values are applied.

Configuration - Section in package org.machanism.machai.gw.maven

 

Configuration setting - Section in class org.machanism.machai.gw.maven.ActMojo

 

configureAndScan(ActProcessor, String) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Resolves the effective act prompt and scans documents when an act is available.

E

excludes - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Paths or patterns skipped during scanning.

execute() - Method in class org.machanism.machai.gw.maven.ActMojo

Executes the configured Ghostwriter act.

execute() - Method in class org.machanism.machai.gw.maven.ActPerModuleMojo

Executes the configured action for the current reactor module.

execute() - Method in class org.machanism.machai.gw.maven.GWMojo

Executes the gw:gw goal.

execute() - Method in class org.machanism.machai.gw.maven.GWPerModuleMojo

Executes the guidance processor for this reactor module.

Execution models - Section in package org.machanism.machai.gw.maven

 

F

findClass(String, File) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Finds fully qualified class names whose simple names match the supplied regular expression.

findClasses(String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Finds classes whose simple names match the supplied regular expression.

forEachNonPrivate(T[], Consumer) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Invokes a consumer for every member that is not private.

FT_NOT_SUPPORTED_FOR_PROJECT_MSG - Static variable in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Message returned when a tool call is made for a project that has not been scanned and registered in this instance.

G

getArtifactId(String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Returns the Maven artifact coordinates associated with the supplied fully qualified class name.

getClassEntries(String, File) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Reads potential class entries from a directory or jar artifact.

getClassInfo(String, File) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Returns reflective information for the specified class.

getClassPath(String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Returns the originating path for the supplied fully qualified class name.

getConfiguration() - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Builds the processor configuration.

getPrompter() - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Returns the interactive prompt provider.

getSourcePath(String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Returns the source file path for the supplied fully qualified class name.

Goal architecture - Section in package org.machanism.machai.gw.maven

 

GW Maven Plugin API - Section in Overview

 

GWMojo - Class in org.machanism.machai.gw.maven

Maven goal that scans project files for Ghostwriter guidance comments and executes the configured AI-assisted processing workflow.

GWMojo() - Constructor for class org.machanism.machai.gw.maven.GWMojo

 

GWPerModuleMojo - Class in org.machanism.machai.gw.maven

Maven goal that processes documents for the current Maven module.

GWPerModuleMojo() - Constructor for class org.machanism.machai.gw.maven.GWPerModuleMojo

 

I

Inherited Maven plugin parameters - Section in class org.machanism.machai.gw.maven.ActMojo

 

Inherited parameters - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo

 

Inherited parameters (from AbstractGWMojo) - Section in class org.machanism.machai.gw.maven.ActPerModuleMojo

 

Inherited parameters (from ActMojo) - Section in class org.machanism.machai.gw.maven.ActPerModuleMojo

 

init() - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Lazily initializes class discovery state on first access.

instructions - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Additional instructions passed to the workflow before scanning.

isSupportedClassEntry(String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Determines whether an archive or directory entry represents a supported Java class.

L

loadClass(String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Loads a class by its fully qualified name using the holder's class loader.

loadClassList(MavenProject) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Builds the project class loader and captures all classes visible from it.

loadClassLocations(MavenProject) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Scans the project's output directory and resolved dependency artifacts to map classes back to their origin.

logger - Static variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Logger shared by Maven goal implementations in this package.

logger - Static variable in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Logger used to report skipped or unloadable class-path entries.

M

Maven parameters - Section in class org.machanism.machai.gw.maven.AbstractGWMojo

 

Maven plugin parameters - Section in class org.machanism.machai.gw.maven.GWMojo

 

MAX_ALLOWED_CLASS_RESULTS - Static variable in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Maximum number of class names returned by a single search.

model - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Provider/model identifier to pass to the workflow, optionally supplied with the "gw.model" Maven property.

MODIFIERS_PROPERTY - Static variable in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

JSON property used for Java modifier text.

MONITOR - Static variable in class org.machanism.machai.gw.maven.AbstractActMojo

Monitor that serializes access to Maven's shared user-property map while an act prompt is resolved.

O

org.machanism.machai.gw.maven - package org.machanism.machai.gw.maven

Provides the Maven-plugin integration layer for Machai Ghostwriter.

org.machanism.machai.gw.maven.tools - package org.machanism.machai.gw.maven.tools

Supplies Maven-integrated function tools for discovering Java classes and inspecting their reflective metadata for a registered project.

P

Packages - Section in Overview

 

Parameters - Section in class org.machanism.machai.gw.maven.ActPerModuleMojo

 

Parameters - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo

 

Parameters declared by this goal - Section in class org.machanism.machai.gw.maven.ActMojo

 

params - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Additional key-value configuration entries merged into the processor configuration.

path - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Optional scan root override.

performAct(String) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Executes the configured act goal.

performAct(String) - Method in class org.machanism.machai.gw.maven.AbstractActPerModuleMojo

Executes the act processor for the current reactor module when this module is eligible for processing.

Plugin configuration - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo

 

populateClassInfo(ClassInfoHolder, String, Class) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Builds the structured metadata response for a resolved class.

process(ActProcessor, String) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Applies runtime configuration to the supplied act processor and starts document scanning.

processClassEntry(String, String, String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Loads and records a class entry when it is visible and has an eligible access level.

Process each module in the current reactor build - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo

 

Processing order for gw:act - Section in class org.machanism.machai.gw.maven.ActMojo

 

project - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Current Maven project, used to determine the module base directory and whether project-aware tools should be registered.

project - Variable in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Maven project used as the source of classpath, output directory, and dependency metadata.

prompter - Variable in class org.machanism.machai.gw.maven.AbstractActMojo

Interactive prompt provider used to collect act input when it is not available from Maven user properties or configuration.

R

readText(String) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Reads multi-line input from the interactive Prompter.

Resolve GenAI credentials from Maven settings - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo

 

resolveProjectByArtifactId(List, Model) - Static method in class org.machanism.machai.gw.maven.GWMojo

Resolves the Maven project from the current session that matches the artifact id of the supplied effective model.

Restrict scanning to a module documentation directory - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo

 

S

scanClassesByPath(String, String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Scans a directory of compiled classes or a jar file and records eligible classes that can be loaded by this holder's class loader.

scanClassesByPath(Set) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Scans each resolved dependency artifact for loadable classes.

scanDocuments(ActProcessor) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Scans the resolved project path with the configured act processor.

scanDocuments(ActProcessor) - Method in class org.machanism.machai.gw.maven.AbstractActPerModuleMojo

Forces the inherited processor to operate on the current module rather than recursively traversing the reactor.

scanDocuments(GuidanceProcessor) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Configures and executes document scanning for the current project context.

scanProjectClasses(MavenProject) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Registers a project by scanning and caching class metadata for its base directory.

serverId - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Maven server id used to resolve GenAI credentials and custom server configuration.

SERVERID_PROP_NAME - Static variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Maven property name for the target GenAI server identifier.

session - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Current Maven session, used to obtain execution-root and request context.

setBasedir(File) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets the Maven module base directory.

setConfigFile(File) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets the optional configuration file to load.

setExcludes(String[]) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets paths or patterns excluded from document scanning.

setInstructions(String) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets additional instructions for the workflow.

setModel(String) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets the provider or model identifier passed to the workflow.

setParams(Map) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets explicit key-value configuration entries.

setPath(String) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets the optional file, directory, glob, or pattern to scan.

setProject(MavenProject) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets the current Maven project.

setPrompter(Prompter) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Sets the interactive prompt provider injected by Plexus.

setServerId(String) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets the Maven server id used to obtain GenAI credentials.

setSession(MavenSession) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets the Maven session that supplies the execution root and request context.

setSettings(Settings) - Method in class org.machanism.machai.gw.maven.AbstractGWMojo

Sets Maven settings used to look up the configured GenAI server.

setSettings(Settings) - Method in class org.machanism.machai.gw.maven.GWMojo

Sets the Maven settings used to resolve configured GenAI credentials.

settings - Variable in class org.machanism.machai.gw.maven.AbstractGWMojo

Maven settings used to resolve credentials and custom configuration from settings.xml.

T

toClassName(String) - Method in class org.machanism.machai.gw.maven.tools.ClassInfoHolder

Converts a compiled-class entry path to a fully qualified class name.

toCoord(MavenProject) - Static method in class org.machanism.machai.gw.maven.GWMojo

Formats a Maven project as a coordinate string used in duplicate-artifact diagnostics.

toParameterTypes(Class[]) - Method in class org.machanism.machai.gw.maven.tools.ClassFunctionalTools

Converts reflective parameter types into fully qualified type names.

Typical usage - Section in package org.machanism.machai.gw.maven.tools

 

U

updateMavenProjectLayout(MavenProjectLayout, Model) - Method in class org.machanism.machai.gw.maven.AbstractActMojo

Updates Maven project layout metadata with the matching reactor project.

updateMavenProjectLayout(MavenProjectLayout, Model) - Method in class org.machanism.machai.gw.maven.ActMojo

Updates Maven layout metadata for the matching reactor project.

Usage examples - Section in class org.machanism.machai.gw.maven.ActPerModuleMojo

 

Usage examples - Section in class org.machanism.machai.gw.maven.GWMojo

 

Usage examples - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo

 

Usage examples - Section in package org.machanism.machai.gw.maven

 

Use instructions and excludes while processing reactor modules - Section in class org.machanism.machai.gw.maven.GWPerModuleMojo