Package org.machanism.machai.gw.processor

Class GWConstants

java.lang.Object
org.machanism.machai.gw.processor.GWConstants
public final class GWConstants extends Object
Defines property names and shared formatting values used by Ghostwriter configuration and runtime processing.

This utility class is not instantiable; its members provide the canonical keys used to read configuration and the fixed values used while processing projects and formatting output.

  • Field Details

    • PROJECT_DIR_PROP_NAME

      public static final String PROJECT_DIR_PROP_NAME
      Property name for the project directory configuration.

      The project directory is the base folder from which Ghostwriter begins analyzing the project's structure. It may point to:

      • The root of a single project (e.g., a Maven or Gradle project root), or
      • A folder containing multiple projects or modules (e.g., a monorepo or a parent directory for several subprojects).
      Ghostwriter supports a variety of project types and layouts, so this property can be configured flexibly to match different setups.
      See Also:

    • GW_CONFIG_FILE_NAME

      public static final String GW_CONFIG_FILE_NAME
      Default Ghostwriter properties file name.

      This is the name of the configuration properties file that can be used as one of the configuration data sources.

      It can be overridden by the CONFIG_PROP_NAME property.

      See Also:

    • CONFIG_PROP_NAME

      public static final String CONFIG_PROP_NAME
      System property used to override the default configuration file name.

      When set, its value replaces GW_CONFIG_FILE_NAME as the configuration properties file to load.

      See Also:

    • MODEL_PROP_NAME

      public static final String MODEL_PROP_NAME
      Configuration property that selects the active AI model or provider.
      See Also:

    • INSTRUCTIONS_PROP_NAME

      public static final String INSTRUCTIONS_PROP_NAME
      Configuration property containing system instructions supplied to the AI provider.
      See Also:

    • EXCLUDES_PROP_NAME

      public static final String EXCLUDES_PROP_NAME
      Configuration property containing paths excluded from processing.
      See Also:

    • ACTS_LOCATION_PROP_NAME

      public static final String ACTS_LOCATION_PROP_NAME
      Configuration property specifying the location of external act definition files (*.toml).

      The value may be an absolute path, a path relative to the root directory, or a URL (starting with http:// or https://) pointing to a remote source.

      See Also:

    • ACT_PROP_NAME

      public static final String ACT_PROP_NAME
      System property used to specify the default action (Act) to run when no explicit act string is provided.

      The value is parsed using the same rules described in the act-parsing lifecycle (task shorthand expansion, episode slicing, argument extraction, etc.), so it accepts any format valid for a raw command string (e.g., "bindex", "bindex/java/mvn-project#2!", ">add javadoc").

      See Also:

    • THREADS_PROP_NAME

      public static final String THREADS_PROP_NAME
      Configuration property specifying the number of threads to use for multi-threaded module processing.

      The value must be a positive integer; non-positive values are rejected.

      See Also:

    • PATH_PROP_NAME

      public static final String PATH_PROP_NAME
      Configuration property specifying the file, directory, or path pattern used to determine which files are scanned within the project directory.

      The value may be an absolute or relative path to a single file, an absolute or relative path to a directory, a glob pattern (e.g., "glob:**/*.java"), or a regex pattern (e.g., "regex:.*\\.java").

      See Also:

    • NONRECURSIVE_PROP_NAME

      public static final String NONRECURSIVE_PROP_NAME
      Configuration property that disables recursive traversal of project modules when enabled.
      See Also:

    • INTERACTIVE_MODE_PROP_NAME

      public static final String INTERACTIVE_MODE_PROP_NAME
      Configuration property that enables interactive command processing.
      See Also:

    • MULTIPLE_LINES_BREAKER

      public static final char MULTIPLE_LINES_BREAKER
      Character that marks a console input line as continuing on the next line.
      See Also:

    • LOG_LINE_LENGTH

      public static final int LOG_LINE_LENGTH
      Maximum line length used when formatting log output.
      See Also:

  • Constructor Details

    • GWConstants

      private GWConstants()
      Prevents instantiation of this utility class.