Record Class McpShaftProjectUpgradeResult

java.lang.Object
java.lang.Record
com.shaft.mcp.McpShaftProjectUpgradeResult
Record Components:
schemaVersion - result schema version
projectRoot - upgraded project root
reportPath - optional upgrader report path
dryRun - whether the upgrader was run in dry-run mode
exitCode - upgrader process exit code
stdout - captured standard output
stderr - captured standard error
timedOut - whether the process exceeded the timeout
command - executed command
public record McpShaftProjectUpgradeResult(String schemaVersion, Path projectRoot, Path reportPath, boolean dryRun, int exitCode, String stdout, String stderr, boolean timedOut, List<String> command) extends Record
Result returned after invoking the SHAFT modular project upgrader through MCP.

  • Field Details

    • CURRENT_SCHEMA_VERSION

      public static final String CURRENT_SCHEMA_VERSION
      Current result schema version.
      See Also:

  • Constructor Details

    • McpShaftProjectUpgradeResult

      public McpShaftProjectUpgradeResult(String schemaVersion, Path projectRoot, Path reportPath, boolean dryRun, int exitCode, String stdout, String stderr, boolean timedOut, List<String> command)
      Creates an immutable project upgrade result.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • schemaVersion

      public String schemaVersion()
      Returns the value of the schemaVersion record component.
      Returns:
      the value of the schemaVersion record component

    • projectRoot

      public Path projectRoot()
      Returns the value of the projectRoot record component.
      Returns:
      the value of the projectRoot record component

    • reportPath

      public Path reportPath()
      Returns the value of the reportPath record component.
      Returns:
      the value of the reportPath record component

    • dryRun

      public boolean dryRun()
      Returns the value of the dryRun record component.
      Returns:
      the value of the dryRun record component

    • exitCode

      public int exitCode()
      Returns the value of the exitCode record component.
      Returns:
      the value of the exitCode record component

    • stdout

      public String stdout()
      Returns the value of the stdout record component.
      Returns:
      the value of the stdout record component

    • stderr

      public String stderr()
      Returns the value of the stderr record component.
      Returns:
      the value of the stderr record component

    • timedOut

      public boolean timedOut()
      Returns the value of the timedOut record component.
      Returns:
      the value of the timedOut record component

    • command

      public List<String> command()
      Returns the value of the command record component.
      Returns:
      the value of the command record component