Index (Ghostwriter 1.1.1 API)

A C D E F G H I J L M N O P R S T
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractFileProcessor - Class in org.machanism.machai.gw.processor: Base implementation for processors that traverse a project directory and perform work on files and folders.
AbstractFileProcessor(File, Configurator) - Constructor for class org.machanism.machai.gw.processor.AbstractFileProcessor: Creates a new file processor.
ACT_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Act format - Search tag in class org.machanism.machai.gw.processor.ActProcessor: Section
ActFunctionTools - Class in org.machanism.machai.gw.tools
ActFunctionTools() - Constructor for class org.machanism.machai.gw.tools.ActFunctionTools
ActProcessor - Class in org.machanism.machai.gw.processor: Processor that runs Ghostwriter in "Act" mode.
ActProcessor(File, Configurator, String) - Constructor for class org.machanism.machai.gw.processor.ActProcessor: Creates an act processor.
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.Ghostwriter
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.
AIFileProcessor - Class in org.machanism.machai.gw.processor
AIFileProcessor(File, Configurator, String) - Constructor for class org.machanism.machai.gw.processor.AIFileProcessor
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.
applyTools(Genai) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
applyTools(Genai) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Registers file read/write/list tools into the provided provider.

C

CONFIG_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Core types - Search tag in Overview: Section
Core types - Search tag in package org.machanism.machai.gw.processor: Section
createActProcessor(CommandLine, File, PropertiesConfigurator, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
createProcessor(CommandLine, File, PropertiesConfigurator, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter

D

deleteTempFiles(File) - Static method in class org.machanism.machai.gw.processor.GuidanceProcessor: Deletes the input-log temporary directory.

E

EXCLUDES_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Execution - Search tag in class org.machanism.machai.gw.processor.ActProcessor: Section
extractPackageName(String) - Static method in class org.machanism.machai.gw.reviewer.JavaReviewer: Extracts the declared package name from a Java source snippet.

F

FileFunctionTools - Class in org.machanism.machai.gw.tools: Installs file-system tools into a Genai.
FileFunctionTools() - Constructor for class org.machanism.machai.gw.tools.FileFunctionTools
findFiles(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Recursively lists all files under a directory, excluding known build/tooling directories.
findFiles(File, String) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Finds all files/directories in the provided project folder that match a pattern.

G

getBaseActList() - Method in class org.machanism.machai.gw.tools.ActFunctionTools
getConfigurator() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the configuration source for this processor.
getDefaultPrompt() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
getDirInfoLine(Collection<String>, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
getExcludes() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns excludes configured for this processor.
getInstructions() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
getModel() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
getModuleThreadTimeoutMinutes() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns timeout (in minutes) to wait for module processing completion during shutdown.
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.
getProjectDir() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the root directory used as a base for relative paths.
getProjectStructureDescription(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
getPrompt(File, File, String) - Method in class org.machanism.machai.gw.reviewer.TextReviewer: Formats the raw guidance content into a prompt fragment.
getProvider() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: FalsePositive Backward-compatible alias kept for configuration/property naming; delegating to getModel() is intentional.
getRelativePath(File, File, boolean) - Static method in class org.machanism.machai.gw.tools.FileFunctionTools: Computes a project-relative path string.
getReviewerForExtension(String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Resolves a reviewer for a given file extension.
getScanDir() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the scan directory used to derive match semantics.
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: Returns the file extensions supported by this reviewer.
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: Returns the file extensions supported by this reviewer.
Ghostwriter - Search tag in Overview: Section
Ghostwriter - Class in org.machanism.machai.gw.processor
Ghostwriter(String, AIFileProcessor) - Constructor for class org.machanism.machai.gw.processor.Ghostwriter
GUIDANCE_TAG_NAME - Static variable in class org.machanism.machai.gw.processor.GuidanceProcessor: Tag name for guidance comments.
GuidanceProcessor - Class in org.machanism.machai.gw.processor: Scans a project tree, extracts per-file @guidance directives through Reviewers, and dispatches the resulting prompts to a configured Genai.
GuidanceProcessor(File, String, Configurator) - Constructor for class org.machanism.machai.gw.processor.GuidanceProcessor: Constructs a processor.
GW_PROJECT_LAYOUT_PROP_PREFIX - Static variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Prefix for project-layout properties exposed for template substitution.
GW_PROPERTIES_FILE_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
GW_TEMP_DIR - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor

H

help(Options) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
High-level architecture - Search tag in Overview: Section
HOME_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
How reviewers are used - Search tag in Overview: Section
How reviewers are used - Search tag in package org.machanism.machai.gw.reviewer: Section
HtmlReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for HTML and XML files (.html, .htm, .xml).
HtmlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.HtmlReviewer

I

initializeConfiguration(File) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
input() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
INPUTS_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
Installed tools - Search tag in class org.machanism.machai.gw.tools.FileFunctionTools: Section
INSTRUCTIONS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
INTERACTIVE_MODE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
isInteractive() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
isLogInputs() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
isModuleDir(ProjectLayout, File) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Checks whether dir is 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.

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

L

loadAct(String, Map<String, Object>, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Loads an act definition into the provided map, supporting inheritance via the basedOn property.
loadReviewers() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Loads file reviewers via the ServiceLoader registry, mapping supported file extensions to a reviewer.
logDefaultPrompt(String, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter

M

main(String[]) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
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, File) - 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, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Applies matching logic and default-guidance behavior.
matchPath(File, File, String, String) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor
MODEL_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
MULTIPLE_LINES_BREAKER - Static variable in class org.machanism.machai.gw.processor.Ghostwriter

N

NONRECURSIVE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
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.
NOT_DEFINED_VALUE - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor

O

org.machanism.machai.gw.processor - Search tag in Overview: Section
org.machanism.machai.gw.processor - package org.machanism.machai.gw.processor: Ghostwriter CLI processing pipeline.
org.machanism.machai.gw.reviewer - Search tag in Overview: Section
org.machanism.machai.gw.reviewer - package org.machanism.machai.gw.reviewer: File-format-aware components that locate embedded @guidance directives in project files and convert them into normalized prompt fragments for Ghostwriter.
org.machanism.machai.gw.tools - Search tag in Overview: Section
org.machanism.machai.gw.tools - package org.machanism.machai.gw.tools

P

Package overview - Search tag in Overview: Section
parseFile(File, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Uses a Reviewer (based on file extension) to extract guidance.
parseLines(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
parseScanDir(File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
pathDepth(String) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Computes the depth of a path for sorting.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.HtmlReviewer: Reviews the given file and returns a formatted prompt fragment when guidance is present.
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 the provided Python file and, if guidance is present, returns a formatted prompt fragment.
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 the provided TypeScript file and, if guidance is present, returns a formatted prompt fragment.
perform(String[]) - Method in class org.machanism.machai.gw.processor.Ghostwriter
process(ProjectLayout, File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Composes the final prompt and dispatches it to the configured provider.
process(ProjectLayout, File, String, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
processFile(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Extracts guidance for a file and, when present, performs provider processing.
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
Processing workflow - Search tag in Overview: Section
processModule(File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Processes a module directory.
processModulesMultiThreaded(File, List<String>) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Processes all discovered modules concurrently.
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Processes non-module files and directories directly under projectDir.
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.ActProcessor: Processes non-module files and directories directly under the project directory.
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Processes files and folders under the parent project directory (excluding modules).
processProjectDir(ProjectLayout, String) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Processes files in a project directory matching a provided pattern or directory.
PROJECT_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
promptBundle - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor: Resource bundle supplying prompt templates for generators.
Provided reviewers - Search tag in Overview: Section
Provided reviewers - Search tag in package org.machanism.machai.gw.reviewer: Section
PumlReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for PlantUML files (.puml).
PumlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.PumlReviewer
Purpose - Search tag in Overview: Section
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

readFromFilePath(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
readFromHttpUrl(String) - Static method in class org.machanism.machai.gw.processor.AIFileProcessor
readText(String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
resolveActPrompt(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
resolveScanDirs(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter
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.

S

SCAN_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
scanDocuments(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Scans documents in the given root directory and prepares inputs for documentation generation.
scanDocuments(File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
scanFolder(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Recursively scans project folders, processing documentation inputs for all found modules and files.
See also - Search tag in Overview: Section
setActData(Map<String, Object>, TomlParseResult) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Copies dotted-string keys from the TOML parse result into properties.
setActsLocation(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Sets the directory used for loading external act definition files.
setConfigurator(Configurator) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
setDefaultPrompt(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Loads an act definition and applies it as the current execution defaults.
setDefaultPrompt(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
setDefaultPrompt(String) - Method in class org.machanism.machai.gw.processor.Ghostwriter
setDegreeOfConcurrency(int) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Enables or disables multi-threaded module processing.
setDegreeOfConcurrency(String) - Method in class org.machanism.machai.gw.processor.Ghostwriter
setExcludes(String[]) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets exclude patterns/paths.
setExcludes(String[]) - Method in class org.machanism.machai.gw.processor.Ghostwriter
setInstructions(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
setInstructions(String) - Method in class org.machanism.machai.gw.processor.Ghostwriter
setInteractive(boolean) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
setLogInputs(boolean) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
setLogInputs(boolean) - Method in class org.machanism.machai.gw.processor.Ghostwriter
setModel(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
setModuleThreadTimeoutMinutes(long) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets the module processing shutdown timeout.
setNonRecursive(boolean) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets whether scanning is restricted to the current directory only.
setPathMatcher(PathMatcher) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets the path matcher used to include only matching files.
setProvider(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: FalsePositive Backward-compatible alias kept for configuration/property naming; delegating to setModel() is intentional.
setScanDir(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets the scan directory that originated the current match operation.
shouldExcludePath(Path) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Determines whether a relative path should be excluded according to AbstractFileProcessor.excludes.
shouldIncludeInFindFiles(File, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Determines whether an entry found in AbstractFileProcessor.findFiles(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.

T

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_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
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) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Attempts to load an act definition from a user-defined directory.
tryToGetInstructionsFromReference(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
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 Overview: Section

A C D E F G H I J L M N O P R S T
All Classes and Interfaces|All Packages|Constant Field Values