Index

A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractFileProcessor - Class in org.machanism.machai.gw.processor
Abstract base implementation for processors that traverse project directories and perform work on their files and folders.
AbstractFileProcessor(File, Configurator) - Constructor for class org.machanism.machai.gw.processor.AbstractFileProcessor
Creates a new file processor.
accept(IOException) - Method in interface org.machanism.machai.gw.tools.CommandFunctionTools.ErrorConsumer
Called when an IOException occurs while reading a stream.
accept(String) - Method in interface org.machanism.machai.gw.tools.CommandFunctionTools.LineConsumer
Consumes a single line of output.
ACT_DEFAULT_PROPS_SECTION_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Prefix section designating default fallback values inside the loaded configurations.
ACT_EXECUTION_INFORMATION_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Prefix used to identify the serialized act and episode metadata injected into an episode prompt.
ACT_FOLDER_NAME - Static variable in class org.machanism.machai.gw.tools.ActFunctionTools
Directory below the runtime temporary directory that stores Act results.
ACT_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Long option name for enabling Act mode and selecting an act.
ACT_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
System property used to specify the default action (Act) to run when no explicit act string is provided.
Act and episode workflow - Search tag in package org.machanism.machai.gw.processor
Section
actBundle - Variable in class org.machanism.machai.gw.processor.ActProcessor
Resource bundle supplying prompt templates for generators.
ActFunctionTools - Class in org.machanism.machai.gw.tools
Provides function tools for managing and executing Ghostwriter Acts within a project.
ActFunctionTools() - Constructor for class org.machanism.machai.gw.tools.ActFunctionTools
Creates an Act-function tool and initializes its MCP prompt-template bundle.
actProcessor - Variable in class org.machanism.machai.gw.processor.Episodes
Processor that receives the result produced by each completed episode.
ActProcessor - Class in org.machanism.machai.gw.processor
Processes named action definitions (“acts”) and executes their prompts against a project, a project directory, or matching files by delegating the actual AI interaction to AIFileProcessor.
ActProcessor(File, String, Configurator) - Constructor for class org.machanism.machai.gw.processor.ActProcessor
Creates an act processor.
actPrompts(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
AI prompt template that instructs the caller to execute an Act identified by name.
actProperties - Variable in class org.machanism.machai.gw.processor.ActProcessor
Map holding the accumulated act configuration properties loaded for execution.
ACTS_BASENAME_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Classpath base directory for built-in act definitions.
ACTS_LOCATION_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property specifying the location of external act definition files (*.toml).
ACTS_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Long option name for selecting a custom acts directory.
actsLocation - Variable in class org.machanism.machai.gw.processor.ActProcessor
Optional directory containing external *.toml act files.
ActSpecFunctionTools - Class in org.machanism.machai.gw.tools
Provides AI-callable functional tools for episode navigation and control within an ActProcessor context.
ActSpecFunctionTools() - Constructor for class org.machanism.machai.gw.tools.ActSpecFunctionTools
 
addMatchingFile(List<File>, PathMatcher, File, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Adds a file to the result when it is eligible for the requested pattern.
addResults(String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Appends a string result item to the execution list.
addTool(FunctionTools) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Adds a tool definition that will be exposed to the AI provider.
advancePastContext(List<String>, String, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Advances beyond a context line, searching forward when its expected position no longer matches exactly.
AIFileProcessor - Class in org.machanism.machai.gw.processor
File processor that drives a configured ProcessProvider provider with project-aware context, prompt metadata, optional external prompt inclusions, public configuration substitution, and function-tool registration.
AIFileProcessor(File, Configurator, String) - Constructor for class org.machanism.machai.gw.processor.AIFileProcessor
Creates a processor for the given project directory and AI provider identifier.
AI metadata and tool providers - Search tag in package org.machanism.machai.gw.tools
Section
append(String) - Method in class org.machanism.machai.gw.tools.LogBuilder
Appends the specified text to the internal log buffer and optionally persists it to disk.
appendContinuedLine(StringBuilder, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Appends a continued input line to the buffer, stripping the trailing continuation marker and replacing it with the platform line separator.
applyActData(Map<String, Object>) - Method in class org.machanism.machai.gw.processor.ActProcessor
Applies loaded act data to this processor's configuration and runtime settings.
applyCommonSettings(AIFileProcessor, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Applies shared processor settings — instructions, excludes, and concurrency — to the given processor, skipping any setting that was not resolved.
applyConcurrency(AIFileProcessor, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Applies the configured concurrency (thread count) setting to the processor when present, logging the resolved value at INFO level.
applyDefaultValues(Map<String, Object>) - Method in class org.machanism.machai.gw.processor.ActProcessor
Populates default properties from the act data, applying configurations and falling back to active configurator values when required.
applyEpisodeSelection(String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Parses and registers specified episode boundaries from an argument string.
applyExcludes(AIFileProcessor, String[]) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Applies exclude patterns to the processor when configured, logging the full list at INFO level.
applyHunk(List<String>, PatchApplier.Hunk, String) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Locates and applies a hunk to the mutable result lines.
applyInstructions(AIFileProcessor, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Applies custom instructions to the processor when present, logging an abbreviated version of the text at INFO level.
applyPatch(File, List<String>, Charset) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Applies a unified or simplified diff patch to a file.
applyPatchLine(List<String>, PatchApplier.PatchLine, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Applies one parsed hunk line at the current result-file index.
applyPatchToFile(File, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Implements apply_patch_to_file.
applyPromptValues(String, Map<String, Object>) - Method in class org.machanism.machai.gw.processor.ActProcessor
Configures user prompt metadata, falling back to act-specified defaults if empty.
applySelectorIfPresent(String, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Applies a CSS selector to the response HTML if one was provided.
applyStringActData(String, String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Applies a single string property to processor state or configuration.
applyStringProperty(String, String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Applies a resolved string property by dispatching to the matching processor setting.
applyTools(String, String[], ProcessProvider, String[]) - Method in class org.machanism.machai.gw.processor.ActProcessor
Applies the tools configured for an act episode, including automatic tool selection requested through the episode's YAML front matter.
applyTools(String, String[], ProcessProvider, String[]) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Registers the selected discovered tools and the tools explicitly added to this processor with the provider for the current request.
applyTools(String, String[], ProcessProvider, String[]) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Configures provider tools, expanding the "auto" shortcut to the built-in command, file, and web function-tool classes before delegating to the base processor.
Architecture - Search tag in Overview
Section
Authentication - Search tag in class org.machanism.machai.gw.tools.WebFunctionTools
Section
autoToolsMap - Variable in class org.machanism.machai.gw.processor.ActProcessor
Cached automatically selected tools, keyed by act name and episode ID.

B

BASED_ON_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Key used to denote inheritance by naming the base configuration to extend.

C

callRestApi(String, String, Map<String, String>, String, int, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Functional AI tool that executes a REST API call to the specified URL using the given HTTP method.
clear() - Method in class org.machanism.machai.gw.tools.LogBuilder
Clears the retained content and resets the truncation flag.
close() - Method in class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable
Shuts down the wrapped executor immediately.
CMD_LOG_PREFIX - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
SLF4J message prefix that includes the command correlation identifier.
collectFilesRecursive(File, File, List<String>, int) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Recursively collects files below currentDir, enforcing the result limit as files are discovered.
collectRecursive(File, File, List<String>, List<String>) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Recursively collects directories and files below currentDir.
CommandFunctionTools - Class in org.machanism.machai.gw.tools
Provides function tools for executing and managing system commands within a project context.
CommandFunctionTools() - Constructor for class org.machanism.machai.gw.tools.CommandFunctionTools
 
CommandFunctionTools.ErrorConsumer - Interface in org.machanism.machai.gw.tools
Functional interface used for handling stream read failures.
CommandFunctionTools.ExecutorServiceAutoCloseable - Class in org.machanism.machai.gw.tools
Auto-closeable wrapper for ExecutorService so it can be used with try-with-resources.
CommandFunctionTools.LineConsumer - Interface in org.machanism.machai.gw.tools
Functional interface used for streaming output line processing.
Command-line entry point and shared types - Search tag in package org.machanism.machai.gw.processor
Section
CommandSecurityChecker - Class in org.machanism.machai.gw.tools
Loads and evaluates command deny-list rules used by host-side command execution tools.
CommandSecurityChecker(Configurator) - Constructor for class org.machanism.machai.gw.tools.CommandSecurityChecker
Creates a new checker and loads deny-list rules from an operating-system specific classpath resource.
CommandSpecFunctionTools - Class in org.machanism.machai.gw.tools
Provides function tools for task and process-execution control within an AIFileProcessor workflow.
CommandSpecFunctionTools() - Constructor for class org.machanism.machai.gw.tools.CommandSpecFunctionTools
 
CONFIG_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Long option name for selecting a configuration file.
CONFIG_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
System property used to override the default configuration file name.
configurator - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Layered, mutable configuration source supplied to processor implementations.
configureActsLocation(CommandLine, PropertiesConfigurator, ActProcessor) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Configures a custom acts location on the given processor when one is provided via the --acts command-line option or configuration.
configureDefaultAct(CommandLine, PropertiesConfigurator, Scanner, ActProcessor) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Configures the default act to run when act mode is enabled.
content - Variable in class org.machanism.machai.gw.tools.PatchApplier.PatchLine
Text of the line without its patch-operation prefix.
CONTEXT_VARIABLE_PREFIX - Static variable in class org.machanism.machai.gw.tools.ProjectContextFunctionTools
Prefix shared by status messages that identify a context variable.
contextProjectMap - Static variable in class org.machanism.machai.gw.tools.ProjectContextFunctionTools
Thread-safe registry that associates each project directory with its mutable context-variable map.
CONTINUE_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Interactive-mode command that accepts the current response and continues processing without sending another prompt to the provider.
countAdded(List<String>) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Counts addition lines in a hunk.
countRemoved(List<String>) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Counts removal lines in a hunk.
createActProcessor(Scanner, PropertiesConfigurator, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Creates an ActProcessor with console-backed interactive input, overriding AIFileProcessor.input() to read from the CLI scanner instead of the default input source.
createOptions() - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Creates the supported CLI option definitions.
createParentDirectory(Path) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Creates the target file's parent directory when it does not exist.
createProcessor(Scanner, PropertiesConfigurator, CommandLine, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Creates either a GuidanceProcessor (default mode) or an ActProcessor (when --act is specified), fully configured for the current run.

D

DEFAULT_CHARSET - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
Default character set used to decode process output streams.
DEFAULT_CHARSET - Static variable in class org.machanism.machai.gw.tools.FileFunctionTools
Default character set used when reading or writing text files.
DEFAULT_CHARSET - Static variable in class org.machanism.machai.gw.tools.WebFunctionTools
Default response character set used by the HTTP tools.
DEFAULT_MODEL_MSG - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Log-message template used when an explicit AI model is selected.
DEFAULT_RESULT_TAIL_SIZE - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
Default maximum number of characters to return from captured process output.
DEFAULT_TASK_MARKER - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Shorthand command prefix indicating that the raw prompt should be interpreted and executed directly as a standard, ad-hoc agent task command.
DEFAULT_TOOLS - Static variable in class org.machanism.machai.gw.processor.GuidanceProcessor
Fully qualified names of the built-in function-tool implementations enabled when a provider has not been configured with any tools.
defaultPrompt - Variable in class org.machanism.machai.gw.processor.AIFileProcessor
Default fallback prompt used to process directories or projects when no specific file prompt is given.
defaultReport(ProjectLayout, File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Normalizes an empty provider response and increments the processed-file counter.
denyCheck(String) - Method in class org.machanism.machai.gw.tools.CommandSecurityChecker
Checks whether the supplied command matches any deny-list rule.
DenyException - Exception Class in org.machanism.machai.gw.tools
Signals that a command has failed a deny-list security check and must not be executed.
DenyException(String) - Constructor for exception class org.machanism.machai.gw.tools.DenyException
Creates a new exception describing the deny-list rule that rejected the command.
denyKeywords - Variable in class org.machanism.machai.gw.tools.CommandSecurityChecker
Case-insensitive keyword rules that reject matching command fragments.
DENYLIST_PROP_NAME - Static variable in class org.machanism.machai.gw.tools.CommandSecurityChecker
Configuration property whose value replaces or extends the loaded deny-list.
denyPatterns - Variable in class org.machanism.machai.gw.tools.CommandSecurityChecker
Compiled regular-expression rules that reject matching command fragments.
disableNormalOrder - Variable in class org.machanism.machai.gw.processor.ActProcessor
Whether normal sequential execution should be skipped after explicit episode processing.
DOCS_DIRS - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
A formatted list/line describing the path information for documentation directories.

E

ENABLED_TOOLS_PARAM_NAME - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Parameter name used to configure the list of tool definitions exposed to the LLM agent during an episode.
endTask(String) - Method in class org.machanism.machai.gw.tools.CommandSpecFunctionTools
Completes the current task by throwing an EndTaskException.
EndTaskException - Exception Class in org.machanism.machai.gw.tools
Exception used to signal the end of a task without terminating the application.
EndTaskException(String) - Constructor for exception class org.machanism.machai.gw.tools.EndTaskException
Constructs a new EndTaskException with the specified detail message.
EPISODE_DELIMETER - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Divider symbol linking the base act name to an optional explicit subset of episodes.
episodeId - Variable in exception class org.machanism.machai.gw.tools.MoveToEpisodeException
Optional one-based identifier of the requested target episode.
episodeName - Variable in exception class org.machanism.machai.gw.tools.MoveToEpisodeException
Optional name of the requested target episode.
EpisodeNotFoundException - Exception Class in org.machanism.machai.gw.processor
Signals that an episode requested by name could not be resolved.
EpisodeNotFoundException(String) - Constructor for exception class org.machanism.machai.gw.processor.EpisodeNotFoundException
Creates an exception for an episode name that could not be resolved.
episodePrompts - Variable in class org.machanism.machai.gw.processor.Episodes
Ordered list of act episode prompts to execute.
episodes - Variable in class org.machanism.machai.gw.processor.ActProcessor
The episodes container managed by this processor.
Episodes - Class in org.machanism.machai.gw.processor
Maintains an ordered collection of act episode prompts and provides execution helpers that support several playback strategies.
Episodes(ActProcessor) - Constructor for class org.machanism.machai.gw.processor.Episodes
Creates an episode collection whose execution results are recorded by the supplied processor.
Example Parse Formats - Search tag in org.machanism.machai.gw.processor.ActProcessor.setAct(String)
Section
Examples - Search tag in class org.machanism.machai.gw.processor.AIFileProcessor
Section
Examples - Search tag in class org.machanism.machai.gw.processor.ActProcessor
Section
Examples - Search tag in class org.machanism.machai.gw.processor.GuidanceProcessor
Section
Example Usage - Search tag in org.machanism.machai.gw.processor.AIFileProcessor.ENABLED_TOOLS_PARAM_NAME
Section
Example Usage - Search tag in org.machanism.machai.gw.processor.AIFileProcessor.PUBLIC_PROP_GROUP_NAME
Section
excludes - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Optional exact paths or path-pattern expressions excluded from traversal.
excludes - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings
Exclude patterns to skip during scanning, or null if not configured.
EXCLUDES_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Long option name for specifying excluded scan paths.
EXCLUDES_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property containing paths excluded from processing.
execute(Scanner, PropertiesConfigurator, CommandLine, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Creates and runs the selected processor (guidance or act mode) against the resolved scan paths, then applies the resulting exit code.
executeCommand(String, Map<String, String>, String, int, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools
Executes a system command using Java's ProcessBuilder for controlled and secure execution.
executeEpisode(int, int, BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes
Runs one iteration of an episode and records its result when completed.
executeEpisodeWithRepeats(int, BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes
Executes an episode repeatedly until its callback completes without asking for another iteration.
executeRegularEpisodes(int, BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes
Executes consecutive episodes until completion or a move request changes the next episode to execute.
executor - Variable in class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable
Executor service whose lifecycle is managed by this wrapper.
ExecutorServiceAutoCloseable(ExecutorService) - Constructor for class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable
Creates a wrapper for the supplied executor service.
EXIT_CODE_ERROR - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Exit code returned for a handled processing failure.
EXIT_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Interactive-mode command that terminates processing immediately by throwing a ProcessTerminationException with exit code 0.
exitCode - Variable in exception class org.machanism.machai.gw.tools.ProcessTerminationException
Exit code that the host should use when terminating execution.
expectedOriginalLines(List<String>) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Extracts the original-file lines required by a hunk.
expectedStart - Variable in class org.machanism.machai.gw.tools.PatchApplier.Hunk
Preferred zero-based location of the original hunk content.
extractInputParams(String, Map<String, Object>) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Extracts supported YAML front-matter input parameters from the beginning of a prompt.
extractPackageName(String) - Static method in class org.machanism.machai.gw.reviewer.JavaReviewer
Extracts the declared package name from a Java source snippet.

F

fetchHttpContent(String, Map<String, String>, int, String, URI, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Fetches HTTP content for a parsed URI.
FILE_INCLUDED_MARKER - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Prefix marker for prompt lines that include external content.
FileFunctionTools - Class in org.machanism.machai.gw.tools
Installs file-system tools into a ProcessProvider.
FileFunctionTools() - Constructor for class org.machanism.machai.gw.tools.FileFunctionTools
 
fillHeader(Map<String, String>, HttpURLConnection, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Applies HTTP headers to the given connection, resolving any property placeholders.
findHunkStart(List<String>, List<String>, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Finds the first complete original-context match nearest the expected start.
FIRST_WHITESPACE - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Pre-compiled regex pattern to identify the first whitespace character in arguments.
folder - Variable in class org.machanism.machai.gw.tools.LogBuilder
Name of the directory beneath the runtime temporary directory where this builder stores its persisted log file.
formatConsole(Console, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Writes a prompt message to the console when available, or to standard output when no Console is attached (e.g., when input is redirected).
FRONT_MATTER_MARKER - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Delimiter that marks the beginning and end of YAML prompt front matter.
Functional areas - Search tag in package org.machanism.machai.gw.tools
Section
functionTools - Variable in class org.machanism.machai.gw.processor.AIFileProcessor
Collection of user-configured function tools that are registered with and made available to the AI provider.
functionToolsLoader - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Loader utility responsible for discovering, instantiating, and applying functional tools to the AI provider.

G

genai - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings
Configured AI provider/model identifier (e.g.
get() - Method in class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable
Returns the wrapped executor service.
getAbsolutePath(String, String, File) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Resolves an act file path or URL from an act name and configured act source.
getActDetails(String, File, Configurator) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
AI functional tool that loads the details of a specific Act template, including its instructions, input template, and configuration options.
getActInformation(int) - Method in class org.machanism.machai.gw.processor.Episodes
Builds metadata describing every configured episode and the current episode.
getActProperties() - Method in class org.machanism.machai.gw.processor.ActProcessor
Returns the merged act properties currently loaded on this processor.
getActResult(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
AI functional tool that retrieves the result of a previously started Act by its process identifier.
getAutoTools(String, String, String[]) - Method in class org.machanism.machai.gw.processor.ActProcessor
Selects and caches the tools required for the current act episode by asking the configured provider for a JSON tool list.
getAutoToolSelectionQuery(String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Extracts the optional query from SnakeYAML's serialized auto mapping value.
getCommandLogPath(String, String) - Static method in class org.machanism.machai.gw.tools.LogBuilder
Returns the path to the log file for the given log identifier.
getConfigurator() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns the configuration source for this processor.
getConnection(String, String, String, String, int, Map<String, String>, String, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Creates and configures a connection for a REST request, including optional request-body transmission.
getConnection(URI, Map<String, String>, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Creates and configures an HttpURLConnection.
getDefaultPrompt() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Returns the default prompt used for folder processing.
getDirInfoLine(Collection<String>, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Returns a JsonNode (ArrayNode) containing the names of directories from the given collection that exist within the specified project directory.
getEnabledTools(Map<String, Object>, LayeredConfigurator) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Resolves the tool names enabled for the current processing request.
getEpisodeId() - Method in exception class org.machanism.machai.gw.tools.MoveToEpisodeException
Returns the requested target episode identifier.
getEpisodeId(Integer, MoveToEpisodeException) - Method in class org.machanism.machai.gw.processor.Episodes
Resolves the next episode index from a move request exception.
getEpisodeIdByName(String) - Method in class org.machanism.machai.gw.processor.Episodes
Finds the 1-based identifier of the episode with the supplied heading.
getEpisodeName(int) - Method in class org.machanism.machai.gw.processor.Episodes
Extracts an episode's first-level Markdown heading, excluding optional YAML-style front matter.
getEpisodes() - Method in class org.machanism.machai.gw.processor.Episodes
Returns the ordered episode prompts.
getExcludes() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns the exclude patterns configured for this processor.
getExitCode() - Method in exception class org.machanism.machai.gw.tools.ProcessTerminationException
Returns the exit code the host should use for termination.
getExpectedStart(String, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Calculates the preferred result-file position from a unified-diff header.
getFile(File, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Resolves a requested path beneath the canonical project root.
getFileName(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
Builds the project-temporary relative file name for an Act result.
getGuidancePrompt(String, File) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Provides the prompt template used to process files containing guidance tags.
getGuidanceTaggedFiles(String, File, Configurator) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Scans the specified directory and its subdirectories for files annotated with guidance tags, returning a mapping of project directories to the files that contain such tags.
getInputId(String[]) - Method in class org.machanism.machai.gw.processor.ActProcessor
Builds the cache key for an act episode from the execution metadata in the prompt.
getInstructions() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Returns the current base instructions used for processing.
getInstructions() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Returns the current base instructions used for processing.
getKey() - Method in enum org.machanism.machai.gw.processor.ProjectContextKey
Gets the raw string value of the metadata key.
getLogMatches(String, String, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools
Searches a persisted command log for all substrings matching the supplied Java regular expression.
getModel() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Returns the configured AI model or provider identifier.
getModuleThreadTimeoutMinutes() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns the timeout (in minutes) to wait for module processing completion during shutdown.
getName() - Method in class org.machanism.machai.gw.processor.Episodes
Returns the logical name associated with this act.
getName() - Method in exception class org.machanism.machai.gw.tools.MoveToEpisodeException
Returns the requested target episode name.
getPath() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns the scan directory used to derive match semantics.
getPathMatcher() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns the matcher used to decide whether a file is included.
getPatternPath(String) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns a PathMatcher when the provided string is a path pattern.
getPreviousLogChunk(String, int, int, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools
Retrieves the chunk of previously captured command output that immediately precedes the current tail window.
getProcessedFiles() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Returns the total number of files processed.
getProcessGuidanceTagFilesResult(String) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Retrieves the result of a previously started guidance tag file processing by its process identifier.
getProcessInfo(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Generates a structured JSON string containing execution metadata about the file being processed and the current processing environment context.
getProjectContextVariables(List<String>, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools
Retrieves the value of a variable from the project-specific context.
getPrompt(File, File, String) - Method in class org.machanism.machai.gw.reviewer.TextReviewer
Formats the raw guidance content into a prompt fragment.
getRecursiveFiles(File, int, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Lists files recursively in a directory up to a specified maximum limit.
getRecursiveFolders(File, int, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Implements get_recursive_folder_list.
getRelativePath(File, File, boolean) - Static method in class org.machanism.machai.gw.tools.FileFunctionTools
Computes a project-relative path string.
getReport() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Returns the mutable list of processing results collected so far.
getReport() - Method in class org.machanism.machai.gw.tools.LogBuilder
Returns a report of the log state, including log ID, retained tail, total length, truncation status, and elapsed process time in milliseconds.
getResults() - Method in class org.machanism.machai.gw.processor.ActProcessor
Returns the list of all collected outputs.
getReviewerForExtension(String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Resolves a reviewer for a given file extension after normalizing the extension to the key format used by the reviewer registry.
getRootDir() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns the root directory used as a base for relative paths.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.HtmlReviewer
Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.JavaReviewer
Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.MarkdownReviewer
Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.PumlReviewer
Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.PythonReviewer
 
getSupportedFileExtensions() - Method in interface org.machanism.machai.gw.reviewer.Reviewer
Returns the file extensions (without the dot) that this reviewer can process.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.TextReviewer
Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.TypeScriptReviewer
 
getTail() - Method in class org.machanism.machai.gw.tools.LogBuilder
Returns the retained content.
getTotalLength() - Method in class org.machanism.machai.gw.tools.LogBuilder
Returns the total number of characters ever appended to this builder.
getWebContent(String, Map<String, String>, int, String, boolean, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Functional AI tool that fetches a web page or project-scoped file URL.
getWebPage(HttpURLConnection, int, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Performs the HTTP GET request and returns the response content.
Ghostwriter - Class in org.machanism.machai.gw.processor
Command-line entry point for the Ghostwriter application.
Ghostwriter() - Constructor for class org.machanism.machai.gw.processor.Ghostwriter
Prevents instantiation of this static CLI entry-point class.
Ghostwriter.RuntimeSettings - Class in org.machanism.machai.gw.processor
Mutable holder for startup settings resolved before processor creation.
Ghostwriter API - Search tag in Overview
Section
GUIDANCE_FILE_NAME - Static variable in class org.machanism.machai.gw.reviewer.TextReviewer
 
GUIDANCE_FOLDER - Static variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Directory below the runtime temporary directory that stores guidance results.
GUIDANCE_TAG_NAME - Static variable in class org.machanism.machai.gw.processor.GuidanceProcessor
Special comment marker used to identify guidance blocks inside supported files.
GuidanceFunctionTools - Class in org.machanism.machai.gw.tools
Provides function tools for discovering and processing files with guidance tags in project directories.
GuidanceFunctionTools() - Constructor for class org.machanism.machai.gw.tools.GuidanceFunctionTools
Creates a guidance function-tools provider using the default prompt resource bundle.
GuidanceProcessor - Class in org.machanism.machai.gw.processor
Processes project files that contain inline guidance comments and dispatches the extracted instructions to the configured AI provider.
GuidanceProcessor(File, String, Configurator) - Constructor for class org.machanism.machai.gw.processor.GuidanceProcessor
Constructs a new GuidanceProcessor for processing files with guidance tags.
GW_CONFIG_FILE_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Default Ghostwriter properties file name.
GWConstants - Class in org.machanism.machai.gw.processor
Defines property names and shared formatting values used by Ghostwriter configuration and runtime processing.
GWConstants() - Constructor for class org.machanism.machai.gw.processor.GWConstants
Prevents instantiation of this utility class.

H

handleExitCode(int) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Terminates the JVM with the given exit code when it is non-zero.
handleProcessingFailure(String, Exception) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Logs a processing failure with the given message prefix and returns the generic error exit code.
handleProcessTermination(ProcessTerminationException) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Handles an explicit process termination request raised by a processor or tool, logging the termination message and reason before returning the exit code requested by the exception.
HEADER_MARKER - Static variable in class org.machanism.machai.gw.processor.Episodes
Prefix that identifies a first-level Markdown episode heading.
Header variable placeholders - Search tag in class org.machanism.machai.gw.tools.WebFunctionTools
Section
HELP_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Long option name for displaying CLI help.
HtmlReviewer - Class in org.machanism.machai.gw.reviewer
A Reviewer implementation for HTML and XML files with the .html, .htm, or .xml extension.
HtmlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.HtmlReviewer
 
HTTP_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Protocol prefix for standard unsecured HTTP endpoints.
HTTPS_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Protocol prefix for secured HTTPS endpoints.
Hunk(int, List<String>) - Constructor for class org.machanism.machai.gw.tools.PatchApplier.Hunk
Creates a patch hunk.

I

indexOfLine(List<String>, String, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Finds a line at or after the supplied index.
initializeConfiguration(CommandLine, String, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Loads the external configuration properties file when present, using either the GWConstants.CONFIG_PROP_NAME system property or the default Ghostwriter properties file name, resolved relative to the project directory.
Inline guidance workflow - Search tag in package org.machanism.machai.gw.processor
Section
input() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Obtains the next input from an interactive user session.
INPUTS_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor
TOML property name containing prompt inputs/episodes.
Installed tools - Search tag in class org.machanism.machai.gw.tools.FileFunctionTools
Section
instructions - Variable in class org.machanism.machai.gw.processor.AIFileProcessor
Base instructions that set the persona, tone, and scope for the AI provider during execution.
instructions - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings
Resolved system instruction text, or null if not configured.
INSTRUCTIONS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
CLI option and configuration-property name for system instructions.
INSTRUCTIONS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property containing system instructions supplied to the AI provider.
INSTRUCTIONS_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor
TOML property name containing the instructions supplied to the AI provider for an act.
interactive - Variable in class org.machanism.machai.gw.processor.AIFileProcessor
Flag indicating whether interactive mode is active, allowing continuous prompt looping and execution.
INTERACTIVE_MODE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property that enables interactive command processing.
isAutoToolSelection(String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Determines whether a front-matter tool value requests automatic selection.
isExtentionExists(String) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Determines whether a file name already contains a non-leading, non-trailing extension separator.
isHunkBoundary(String) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Determines whether a line begins another hunk or file section.
isInteractive() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Indicates whether interactive processing mode is enabled.
isModuleDir(ProjectLayout, File) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Checks whether dir is located in one of the project module directories.
isNonRecursive() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Returns whether recursion into modules/subdirectories is disabled.
isPathPattern(String) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Tests whether a scan pattern string is a glob: or regex: matcher.
isRegularOrder() - Method in class org.machanism.machai.gw.processor.Episodes
Determines whether all episodes should execute in their natural order.

J

JavaReviewer - Class in org.machanism.machai.gw.reviewer
Reviewer implementation for Java source files (.java).
JavaReviewer() - Constructor for class org.machanism.machai.gw.reviewer.JavaReviewer
 

K

key - Variable in enum org.machanism.machai.gw.processor.ProjectContextKey
Raw string representation used to identify this context value in the backend registry map.

L

LAYOUT_TYPE - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The classification or structure style of the layout (e.g., Maven, Gradle, Custom).
length() - Method in class org.machanism.machai.gw.tools.LogBuilder
Returns the number of characters currently retained.
lines - Variable in class org.machanism.machai.gw.tools.PatchApplier.Hunk
Raw, prefix-preserving patch lines that comprise the hunk.
listFiles(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Recursively lists all files under a directory, excluding known build/tooling directories.
listFiles(File, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Lists the contents of a specified directory within a project, grouping the results into separate lists for directories and files using their relative paths.
listFiles(File, String) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Finds all files/directories in the provided project folder that match a pattern.
loadAct(String, Map<String, Object>, String, File) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Loads an act definition into the provided map, supporting inheritance via the basedOn property.
loadActToml(String) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Loads and parses an act TOML document from a local file or remote URL.
loadReviewers() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Loads file reviewers via the ServiceLoader registry, mapping each supported normalized extension to the first reviewer that declares it.
loadRules(String) - Method in class org.machanism.machai.gw.tools.CommandSecurityChecker
Loads deny-list rules from the provided string.
loadRuntimeSettings(CommandLine, PropertiesConfigurator, Scanner) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Resolves runtime settings from CLI arguments and persisted configuration.
LOG_EXTENSION - Static variable in class org.machanism.machai.gw.tools.LogBuilder
Standard filename extension assigned to persisted command log files.
LOG_FOLDER - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
Directory below the runtime temporary directory that stores command logs.
LOG_LINE_LENGTH - Static variable in class org.machanism.machai.gw.processor.GWConstants
Maximum line length used when formatting log output.
LOG_OUTPUT_PREFIX - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
The format pattern used to prepend logger output blocks when reporting responses generated by the AI provider.
logAbbreviatedMessage(String, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Logs an abbreviated value at INFO level, skipping the abbreviation work entirely when INFO logging is disabled.
logActCompletion(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
Writes the Act completion banner when INFO logging is enabled.
LogBuilder - Class in org.machanism.machai.gw.tools
A StringBuilder-like helper that retains only the last maxSize characters.
LogBuilder(String, int, String, File) - Constructor for class org.machanism.machai.gw.tools.LogBuilder
Creates a builder that keeps at most maxSize characters.
logEpisodeHeader(int, int, String) - Method in class org.machanism.machai.gw.processor.Episodes
Logs a visual boundary around an episode execution when episode or iteration information is useful.
logger - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Logger for documentation input processing events.
logger - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Logger for processing lifecycle, diagnostic, and included-content messages.
logger - Static variable in class org.machanism.machai.gw.processor.Episodes
Logger for documentation input processing events.
logger - Static variable in class org.machanism.machai.gw.processor.GuidanceProcessor
Logger used to record processor initialization and provider output.
logger - Static variable in class org.machanism.machai.gw.tools.ActFunctionTools
Logger for Act execution lifecycle events and diagnostics.
logger - Static variable in class org.machanism.machai.gw.tools.ActSpecFunctionTools
Logger used to emit the optional response message before the current episode is repeated.
logger - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
Logger for shell tool execution and diagnostics.
logger - Static variable in class org.machanism.machai.gw.tools.CommandSecurityChecker
Logger used to report deny-list loading diagnostics.
logger - Static variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Logger used to report asynchronous guidance-processing failures.
logger - Static variable in class org.machanism.machai.gw.tools.WebFunctionTools
Logger for web fetch tool execution and diagnostics.
LOGGER - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Logger for CLI lifecycle, configuration, and processing events.
logId - Variable in class org.machanism.machai.gw.tools.LogBuilder
Optional identifier used as the base name of the persisted log file.
logResult(String) - Method in class org.machanism.machai.gw.processor.Episodes
Logs a nonblank execution result using the standard output prefix.
logStartup(File) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Logs the resolved project directory at INFO level.
logVersion() - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Logs the application version when available from package metadata.

M

main(String[]) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Starts the Ghostwriter CLI.
MarkdownReviewer - Class in org.machanism.machai.gw.reviewer
Reviewer implementation for Markdown files (.md).
MarkdownReviewer() - Constructor for class org.machanism.machai.gw.reviewer.MarkdownReviewer
 
match(File, ProjectLayout) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Determines whether the specified file should be included for processing based on exclusion rules, path matching patterns, and project structure.
match(File, ProjectLayout) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Applies path matching while preserving default-guidance behavior when no path matcher is configured.
matchesAt(List<String>, List<String>, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Checks whether expected lines match the file at an index.
matchLines(List<String>, List<String>, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Compares expected lines to a consecutive segment of file lines.
maxSize - Variable in class org.machanism.machai.gw.tools.LogBuilder
Maximum number of characters retained in LogBuilder.sb after each append.
mcpPromptBundle - Variable in class org.machanism.machai.gw.tools.ActFunctionTools
Resource bundle that supplies MCP prompt templates for Act execution.
mcpPromptBundle - Variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Resource bundle that supplies prompt templates exposed through Prompt methods in this tool provider.
mergeStringWithListValue(List<String>, String, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Merges a single string value into each string item of an inherited list.
mergeTomlArrayValues(Object, List<Object>, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Merges TOML array values with any existing inherited string or list value.
model - Variable in class org.machanism.machai.gw.processor.AIFileProcessor
The specific AI model identifier or provider label being utilized for operations.
MODEL_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Long option name for selecting an AI provider and model.
MODEL_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property that selects the active AI model or provider.
MODULES - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
A formatted list/line describing the project sub-modules.
moduleThreadTimeoutMinutes - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Maximum number of minutes to await module worker-pool termination before forcing shutdown.
moveToEpisode(int, String) - Method in class org.machanism.machai.gw.tools.ActSpecFunctionTools
AI functional tool that requests navigation to the episode identified by its id or name.
MoveToEpisodeException - Exception Class in org.machanism.machai.gw.tools
Control-flow exception that requests navigation to a named or numbered Act episode.
MoveToEpisodeException(Integer, String) - Constructor for exception class org.machanism.machai.gw.tools.MoveToEpisodeException
Creates a navigation request for an episode identifier or name.
MULTIPLE_LINES_BREAKER - Static variable in class org.machanism.machai.gw.processor.GWConstants
Character that marks a console input line as continuing on the next line.
multiThread - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings
Configured thread count as text, or null if not configured.

N

name - Variable in class org.machanism.machai.gw.processor.Episodes
Logical act name associated with the episodes.
NO_INTERACTIVE_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Interactive-mode command that accepts the current response and continues processing in a non-interactive mode, running to completion without prompting the user again.
nonRecursive - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Indicates whether module discovery and recursive module processing are disabled for the current run.
NONRECURSIVE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property that disables recursive traversal of project modules when enabled.
normalizeExtensionKey(String) - Static method in class org.machanism.machai.gw.processor.GuidanceProcessor
Normalizes a file extension (with or without a leading dot) into a lower-case lookup key.

O

OPERATING_SYSTEM - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The operating system name where the application is currently running.
operation - Variable in class org.machanism.machai.gw.tools.PatchApplier.PatchLine
Patch operation: a space for context, a plus sign for addition, or a minus sign for removal.
org.machanism.machai.gw.processor - package org.machanism.machai.gw.processor
Provides the filesystem traversal, provider orchestration, act execution, and command-line entry point used by Ghostwriter (GW).
org.machanism.machai.gw.reviewer - package org.machanism.machai.gw.reviewer
Provides the file-format-specific review layer for the Ghostwriter guidance processing pipeline.
org.machanism.machai.gw.tools - package org.machanism.machai.gw.tools
Supplies the host-side, AI-callable tools used by the Ghostwriter runtime.

P

Packages - Search tag in Overview
Section
PARENT_PROJECT_DIR_NAME - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The directory name of the parent project folder, or null if the project has no parent.
PARENT_PROJECT_ID - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The unique identifier of the parent project, if one exists.
parseFile(File, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Uses a Reviewer (based on file extension) to extract guidance.
parseLines(String, File, Configurator) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Normalizes multi-line input and resolves supported line references such as HTTP URLs and file: references.
parsePatchLine(String) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Parses one hunk line into its operation and unprefixed content.
parsePath(File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Resolves the effective scan directory and converts it into a glob expression when required.
parseResult(String, String, HttpURLConnection, int, StringBuilder) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Reads the response stream and returns the full response text.
PatchApplier - Class in org.machanism.machai.gw.tools
Applies unified and simplified search-and-replace diff patches to text files.
PatchApplier() - Constructor for class org.machanism.machai.gw.tools.PatchApplier
Prevents instantiation of this static utility class.
PatchApplier.Hunk - Class in org.machanism.machai.gw.tools
Represents a patch hunk and its preferred zero-based starting position.
PatchApplier.PatchLine - Class in org.machanism.machai.gw.tools
Represents a parsed context, addition, or removal line in a patch hunk.
PatchLine(char, String) - Constructor for class org.machanism.machai.gw.tools.PatchApplier.PatchLine
Creates a parsed patch line.
path - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Specifies a special scanning path or path pattern.
PATH_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property specifying the file, directory, or path pattern used to determine which files are scanned within the project directory.
pathDepth(String) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Computes the depth of a path for sorting.
pathMatcher - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Optional matcher that limits file or module processing to matching paths.
paths - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings
Scan directories or patterns to process.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.HtmlReviewer
Reviews the given file and returns a formatted prompt fragment when the file contains the configured guidance tag in an HTML/XML comment.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.JavaReviewer
Reviews the provided Java file and, if guidance is present, returns a formatted prompt fragment.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.MarkdownReviewer
Reviews the given Markdown file and returns a formatted prompt fragment when guidance is present.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.PumlReviewer
Reviews the given PlantUML file for contained guidance comments and formats the content for input to documentation generators.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.PythonReviewer
Reviews a Python file for line-comment or triple-quoted guidance.
perform(File, File) - Method in interface org.machanism.machai.gw.reviewer.Reviewer
Reviews a file and returns a formatted fragment (often including file content and/or extracted guidance) for use by the Ghostwriter pipeline.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.TextReviewer
Reads and formats the guidance file if the provided file is named @guidance.txt.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.TypeScriptReviewer
Reviews a TypeScript file for line-comment or block-comment guidance.
perform(File, ProcessProvider) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Executes the provider and, when interactive mode is enabled, processes the next user command or follow-up prompt.
performAct(String, Map<String, String>, boolean, File, Configurator) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
AI functional tool that performs the specified Act by name.
popProjectContextVariable(String, String, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools
Removes and returns a value from a project context variable.
printHelp(Options) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Prints CLI help text, including usage syntax, all available options, and example invocations, to standard output.
process(ProjectLayout, File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Processes the given file using the currently configured instructions.
process(ProjectLayout, File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Composes the final prompt, dispatches it to the configured provider, and adds the resulting message to this processor's report.
process(ProjectLayout, File, String, int) - Method in class org.machanism.machai.gw.processor.ActProcessor
Executes a single episode prompt after prepending act metadata.
process(ProjectLayout, File, String, String...) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Processes a specified file within a project layout by configuring and invoking a Generative AI (GenAI) provider using a sequence of instructions and prompts.
PROCESS_ID_KEY - Static variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Response-map key for an asynchronous guidance execution identifier.
processDefaultGuidance(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Processes the project directory with the configured default prompt when the directory matches the active scan criteria.
processedFilesCounter - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor
Number of files for which processing has been attempted successfully.
processFile(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Processes one file in a project layout.
processFile(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.ActProcessor
Executes the act against a single file.
processFile(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Extracts guidance for a file and, when present, performs provider processing.
processFolder(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Processes a project layout for documentation gathering.
processFolder(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Processes the project root folder using the configured default prompt.
processGuidanceTagFiles(String, Map<String, String>, String, boolean, File, Configurator) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Asynchronously processes files with guidance tags using the configured model.
processModule(File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Processes a module directory after determining whether it is relevant to the configured scan path.
processModulesMultiThreaded(ProjectLayout, List<String>) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Processes all discovered modules concurrently.
processModulesMultiThreaded(ProjectLayout, List<String>) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Processes the project modules in a multi-threaded manner using the specified layout and module list.
Processor architecture - Search tag in package org.machanism.machai.gw.processor
Section
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Processes non-module files and directories directly under rootDir.
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.ActProcessor
Processes files and folders under the parent project directory (excluding modules).
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Processes files and folders under the parent project directory, excluding module directories.
processPathectories(AIFileProcessor, String[], File) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Processes all requested scan paths using the given processor, converting recognized failures into an appropriate exit code instead of propagating them further, and always logging usage statistics and completion.
processProjectDir(ProjectLayout, String) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Processes files in a project directory matching a provided pattern or directory.
ProcessTerminationException - Exception Class in org.machanism.machai.gw.tools
Runtime control-flow exception that requests host application termination.
ProcessTerminationException(int) - Constructor for exception class org.machanism.machai.gw.tools.ProcessTerminationException
Creates a termination request with an exit code and no detail message.
ProcessTerminationException(String, int) - Constructor for exception class org.machanism.machai.gw.tools.ProcessTerminationException
Creates a termination request with a detail message and exit code.
ProcessTerminationException(String, Throwable, int) - Constructor for exception class org.machanism.machai.gw.tools.ProcessTerminationException
Creates a termination request with a detail message, cause, and exit code.
processTimeoutSeconds - Variable in class org.machanism.machai.gw.tools.CommandFunctionTools
Maximum number of seconds to wait for a started process before forcibly terminating it.
PROJECT_DIR_NAME - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The directory name of the project folder itself.
PROJECT_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
CLI option and configuration-property name for the project directory.
PROJECT_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Property name for the project directory configuration.
PROJECT_ID - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The unique identifier of the project.
PROJECT_NAME - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The user-friendly name of the project.
ProjectContextFunctionTools - Class in org.machanism.machai.gw.tools
Provides function tools for managing project-specific context variables.
ProjectContextFunctionTools() - Constructor for class org.machanism.machai.gw.tools.ProjectContextFunctionTools
 
ProjectContextKey - Enum in org.machanism.machai.gw.processor
Represents the context metadata keys used for evaluating and storing project layouts.
ProjectContextKey(String) - Constructor for enum org.machanism.machai.gw.processor.ProjectContextKey
Constructs a ProjectContextKey constant mapped to its raw string representation.
projectDir - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings
Resolved project directory.
projectDir - Variable in class org.machanism.machai.gw.tools.LogBuilder
Optional project directory marker indicating that appended content should also be persisted.
PROMPT_BUNDLE - Static variable in class org.machanism.machai.gw.reviewer.PumlReviewer
 
promptBundle - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor
Resource bundle that supplies the default system instructions and guidance rules used when no explicit instructions are configured.
promptBundle - Variable in class org.machanism.machai.gw.reviewer.HtmlReviewer
The resource bundle used to obtain localized prompt templates for HTML and XML files.
promptBundle - Variable in class org.machanism.machai.gw.reviewer.JavaReviewer
Localized prompt templates used to construct review requests for Java source files.
promptBundle - Variable in class org.machanism.machai.gw.reviewer.MarkdownReviewer
 
promptBundle - Variable in class org.machanism.machai.gw.reviewer.PythonReviewer
Resource bundle containing prompt templates for reviewed files.
promptBundle - Variable in class org.machanism.machai.gw.reviewer.TextReviewer
 
promptBundle - Variable in class org.machanism.machai.gw.reviewer.TypeScriptReviewer
Resource bundle containing prompt templates for reviewed files.
promptForValue(Scanner, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Prompts the user for a single (possibly multi-line) piece of input on standard input, printing the prompt via Console when available or plain System.out otherwise.
PUBLIC_PROP_GROUP_NAME - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
Prefix for property groups whose values are exposed and injectable directly into prompt templates.
PUBLIC_USER_PROMPT_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Property name representing the user prompt configured publicly inside the properties.
PumlReviewer - Class in org.machanism.machai.gw.reviewer
Reviewer implementation for PlantUML files (.puml).
PumlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.PumlReviewer
 
pushProjectContextVariable(String, String, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools
Pushes a value to a project context variable.
put(File, String, Object) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools
Sets or updates a variable in the context map for the specified project directory.
putProjectContextVariable(String, String, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools
Sets or updates a project context variable to save and share data between acts.
putStringActData(Map<String, Object>, String, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Stores a string property, merging it with any inherited value already present.
PythonReviewer - Class in org.machanism.machai.gw.reviewer
Reviewer implementation for Python source files (.py).
PythonReviewer() - Constructor for class org.machanism.machai.gw.reviewer.PythonReviewer
 

R

RANDOM - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
Reusable random instance used for generating lightweight command ids for logging.
RANDOM - Static variable in class org.machanism.machai.gw.tools.WebFunctionTools
Source of correlation identifiers used in request log messages.
readActInput(Scanner) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Reads possibly multi-line interactive act input from standard input, printing the Ghostwriter.USER_INPUT_PREFIX prompt before each line and supporting the same continuation-marker convention as Ghostwriter.promptForValue(Scanner, String).
readFile(File, String, int, File, Configurator) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Implements read_file.
readFileContent(File, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Reads a local file using the requested character set.
readFileUriContent(File, String, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Resolves a project-scoped file: URI and reads the referenced file.
readFromFilePath(String, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Reads UTF-8 text content from the given file path.
readFromHttpUrl(String) - Static method in class org.machanism.machai.gw.processor.AIFileProcessor
Reads UTF-8 text content from the given HTTP or HTTPS URL.
readHunk(List<String>, int, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Reads the hunk beginning at a patch header.
readStream(InputStream, String, LogBuilder, CommandFunctionTools.LineConsumer, CommandFunctionTools.ErrorConsumer) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools
Reads a process stream and appends its content to output while also passing each line to the provided consumer.
regularOrder(Integer, BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes
Executes episodes in regular order starting from the supplied 1-based index while honoring repeat and move requests.
REL_PATH_FROM_ROOT - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
The relative filesystem path from the root directory to the project's directory.
removeFrontMatterData(String) - Static method in class org.machanism.machai.gw.processor.AIFileProcessor
Removes a leading, complete YAML front-matter block from a prompt.
removeLine(List<String>, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Removes a line at the current patch position.
renderTextOnlyIfRequested(boolean, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
Converts the response to plain text when requested.
repeateEpisode(String) - Method in class org.machanism.machai.gw.tools.ActSpecFunctionTools
AI functional tool that repeats the current episode by terminating its execution and restarting the same episode while preserving its context.
RepeatEpisodeException - Exception Class in org.machanism.machai.gw.tools
Runtime control-flow exception that requests repetition of the current Act episode.
RepeatEpisodeException() - Constructor for exception class org.machanism.machai.gw.tools.RepeatEpisodeException
Creates an exception that requests repetition of the current Act episode.
report - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor
Provider results accumulated during this processor instance's lifetime.
requestedOrder(BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes
Executes only the explicitly selected episodes in their requested order.
resolveExcludes(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Resolves the exclude list from the --excludes command-line option or configuration, splitting the comma-separated value into individual patterns.
resolveGenai(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Resolves the configured AI provider/model, preferring the --model command-line option over the corresponding configuration value.
resolveInheritedValue(String, String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Resolves a property value against the current configurator for inheritance.
resolveInputParamValue(Object) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Resolves configuration placeholders in a parsed front-matter value.
resolveInstructions(CommandLine, PropertiesConfigurator, Scanner) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Resolves the system instruction text from CLI input or configuration.
resolveMergedValue(List<String>, int, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Resolves a merged value for an inherited prompt slot.
resolveMultiThread(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Resolves the concurrency (thread count) setting from the --threads command-line option or configuration.
resolvePaths(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Resolves the scan directories or patterns to process, in order of precedence: positional command-line arguments, then the configured path property, then the current directory (".") as a final fallback.
resolveProjectDir(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
Resolves the project directory from the -d command-line option or configuration.
resolvePromptValues(List<String>) - Method in class org.machanism.machai.gw.processor.ActProcessor
Resolves inherited placeholders for each prompt episode.
resolveWorkingDir(File, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools
Resolves a working directory relative to a canonical project directory.
results - Variable in class org.machanism.machai.gw.processor.ActProcessor
List of collected outputs generated during processing.
Reviewer - Interface in org.machanism.machai.gw.reviewer
Service-provider interface (SPI) for components that scan project files and extract @guidance instructions for downstream processing.
reviewerMap - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor
Reviewers indexed by normalized, dot-free lower-case file extension.
rootDir - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Root directory used to calculate project-relative paths during the current processing run.
RuntimeSettings() - Constructor for class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings
Creates an empty settings holder for values resolved during CLI startup.

S

saveAsyncActResult(ActProcessor, File, String, String, File) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
Runs an Act in the background and persists its result for later polling.
saveGuidanceResult(GuidanceProcessor, File, String, File) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Runs guidance processing in the background and persists its report.
sb - Variable in class org.machanism.machai.gw.tools.LogBuilder
Mutable buffer containing the most recently appended, retained log content.
scanDocuments(File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Configures scanning based on the provided directory or path pattern and then starts scanning the project folder.
scanDocuments(File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
Scans the requested project location and logs the number of files processed after the scan completes.
scanFolder(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Recursively scans project folders, processing documentation inputs for all found modules and files.
selectedEpisodes - Variable in class org.machanism.machai.gw.processor.Episodes
Explicitly selected 1-based episode identifiers.
SEPARATOR_CHARS - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Separator character used to delimit collection values like lists of files or episode indices.
serialVersionUID - Static variable in exception class org.machanism.machai.gw.processor.EpisodeNotFoundException
Serialization version identifier for this exception type.
serialVersionUID - Static variable in exception class org.machanism.machai.gw.tools.DenyException
Serialization version for this exception type.
serialVersionUID - Static variable in exception class org.machanism.machai.gw.tools.EndTaskException
Serialization version for this control-flow exception.
serialVersionUID - Static variable in exception class org.machanism.machai.gw.tools.MoveToEpisodeException
Serialization version for compatibility when this control-flow exception is serialized.
serialVersionUID - Static variable in exception class org.machanism.machai.gw.tools.ProcessTerminationException
Serialization version for this control-flow exception.
serialVersionUID - Static variable in exception class org.machanism.machai.gw.tools.RepeatEpisodeException
Serialization version for this control-flow exception.
setAct(String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Configures and initializes the current execution Action (Act) context by parsing the raw command string.
setActData(Map<String, Object>, TomlParseResult) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Copies dotted-string keys from the TOML parse results into properties.
setActDataEntry(Map<String, Object>, Map.Entry<String, Object>) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Applies a single TOML entry to the merged act property map.
setActsLocation(String) - Method in class org.machanism.machai.gw.processor.ActProcessor
Sets the location used for loading external act definition files (*.toml).
setDefaultPrompt(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Sets the default prompt used for folder processing.
setDisableNormalOrder(boolean) - Method in class org.machanism.machai.gw.processor.ActProcessor
Enables or disables continuation with the default episode execution order.
setEpisodes(List<String>) - Method in class org.machanism.machai.gw.processor.Episodes
Replaces the ordered prompts available for execution.
setExcludes(String[]) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Sets exclude patterns or paths.
setInstructions(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Sets the base instructions used for processing after normalizing line content and resolving supported references.
setInteractive(boolean) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Enables or disables interactive processing mode.
setModel(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Sets the AI model or provider identifier.
setModuleThreadTimeoutMinutes(long) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Sets the module processing shutdown timeout.
setName(String) - Method in class org.machanism.machai.gw.processor.Episodes
Assigns the logical name associated with this act.
setNonRecursive(boolean) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Sets whether scanning is restricted to the current directory only.
setPath(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Sets the scan directory that originated the current match operation.
setPathMatcher(PathMatcher) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Sets the path matcher used to include only matching files.
setProjectLayoutContext(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Extracts context metadata from the provided ProjectLayout and registers it in the project context registry.
setSelectedEpisodes(List<Integer>) - Method in class org.machanism.machai.gw.processor.Episodes
Sets the list of explicitly requested episode identifiers.
setThreads(int) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Configures the number of threads to be used for multi-threaded module processing.
shouldExcludePath(Path) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Determines whether a relative path should be excluded according to AbstractFileProcessor.excludes.
shouldIncludeInListFiles(File, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Determines whether an entry found in AbstractFileProcessor.listFiles(File) should be included.
shutdownExecutor(ExecutorService) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
Shuts down an ExecutorService safely without throwing from a finally block.
size() - Method in class org.machanism.machai.gw.processor.Episodes
Returns the number of configured episode prompts.
SRC_AND_RESOURCE_DIRS - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
A formatted list/line describing the path information for the main source and resource directories.
startTime - Variable in class org.machanism.machai.gw.tools.LogBuilder
Epoch time in milliseconds at which this builder was created.
STATUS_KEY - Static variable in class org.machanism.machai.gw.tools.ActFunctionTools
Response-map key that identifies the asynchronous Act execution status.
STATUS_KEY - Static variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Response-map key for an asynchronous guidance execution status.
STOP_SYMBOL - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Character symbol that triggers immediate termination and disables normal order progression.
SUPER_VALUE_PLACEHOLDER - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Placeholder string used in inherited act definitions to reference and include the parent's value.
Supported prompt input parameters - Search tag in class org.machanism.machai.gw.processor.AIFileProcessor
Section
Supported special markers and parameters - Search tag in class org.machanism.machai.gw.processor.AIFileProcessor
Section

T

TASK_TERMINATED_BY_FUNCTION_TOOL_MESSAGE - Static variable in class org.machanism.machai.gw.tools.CommandSpecFunctionTools
Default explanatory message used when a control-flow tool is invoked without an explicit message.
terminateExecution(String, int, File) - Method in class org.machanism.machai.gw.tools.CommandSpecFunctionTools
Requests application termination by throwing a ProcessTerminationException.
TEST_SRC_AND_RESOURCE_DIRS - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey
A formatted list/line describing the path information for test source and resource directories.
TextReviewer - Class in org.machanism.machai.gw.reviewer
Reviewer implementation for generic guidance text files.
TextReviewer() - Constructor for class org.machanism.machai.gw.reviewer.TextReviewer
 
threads - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor
Number of worker threads used for module processing.
THREADS_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Long option name for configuring processing concurrency.
THREADS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants
Configuration property specifying the number of threads to use for multi-threaded module processing.
TOML_EXTENSION - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Expected file extension for configurations parsed as TOML files.
TOOL_AUTO_SEARCH_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor
Front-matter value that requests provider-assisted selection of the tools needed by an act episode.
toStringList(Object) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Converts an inherited property value to a list of strings.
totalLength - Variable in class org.machanism.machai.gw.tools.LogBuilder
Total number of characters accepted by LogBuilder.append(String) since this instance was created, including content no longer retained in LogBuilder.sb.
truncated - Variable in class org.machanism.machai.gw.tools.LogBuilder
Whether content has been removed from the beginning of the buffer since the last call to LogBuilder.clear().
tryLoadActFromClasspath(Map<String, Object>, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Attempts to load an act definition from classpath resources.
tryLoadActFromDirectory(Map<String, Object>, String, String, File) - Static method in class org.machanism.machai.gw.processor.ActProcessor
Attempts to load an act definition from a user-defined directory.
tryToGetFromReference(String, File, Configurator) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
Resolves a single instruction line that may point to external content.
TypeScriptReviewer - Class in org.machanism.machai.gw.reviewer
Reviewer implementation for TypeScript source files (.ts).
TypeScriptReviewer() - Constructor for class org.machanism.machai.gw.reviewer.TypeScriptReviewer
 
Typical usage - Search tag in package org.machanism.machai.gw.processor
Section
Typical usage - Search tag in package org.machanism.machai.gw.tools
Section
Typical use - Search tag in Overview
Section

U

Usage Example - Search tag in class org.machanism.machai.gw.tools.WebFunctionTools
Section
USER_INPUT_PREFIX - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Prefix displayed before interactive Act-mode input.

V

validatePatchResult(List<String>, List<String>, String) - Static method in class org.machanism.machai.gw.tools.PatchApplier
Rejects unsafe or ineffective patch results.
valueOf(String) - Static method in enum org.machanism.machai.gw.processor.ProjectContextKey
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.machanism.machai.gw.processor.ProjectContextKey
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitAndCollect(Process, LogBuilder, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools
Waits for the specified process to complete execution within the configured timeout, collects its output, and returns a report of the captured output.
WebFunctionTools - Class in org.machanism.machai.gw.tools
Provides host-side HTTP retrieval tools for a ProcessProvider provider.
WebFunctionTools() - Constructor for class org.machanism.machai.gw.tools.WebFunctionTools
 
writeFile(File, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Implements write_file.
writeFileContent(File, String, String) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Writes content to file using charsetName.
writeGuidanceResult(File, List<Map<String, Object>>) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools
Serializes a guidance-processing report to its temporary result file.
writeNewFile(File, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Creates the file (and parent directories as needed) and writes text using the requested character set.
A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form