Enum Class OutputMode

java.lang.Object
java.lang.Enum<OutputMode>
org.egothor.methodatlas.OutputMode
All Implemented Interfaces:
Serializable, Comparable<OutputMode>, Constable

public enum OutputMode extends Enum<OutputMode>
Output formats supported by the MethodAtlas application.

The selected mode determines both the emitted header and the per-method output representation.

See Also:
  • Enum Constant Details

    • CSV

      public static final OutputMode CSV
      Emits output in comma-separated value format.

      Fields are escaped according to RFC 4180 rules implemented by OutputEmitter.

    • PLAIN

      public static final OutputMode PLAIN
      Emits output in a human-readable plain text format.
    • SARIF

      public static final OutputMode SARIF
      Emits output in SARIF 2.1.0 JSON format.

      Results are buffered in memory and serialized to a single JSON document after all source files have been scanned. Security-relevant methods receive SARIF level note and a security-severity score derived from the AI taxonomy tag; rule objects carry a properties.tags array for the GitHub Code Scanning tag filter.

      Security-only by default: SARIF output is intended for consumption by GitHub Code Scanning and equivalent security tooling. These consumers expect actionable security findings, not an exhaustive inventory of every test method. Selecting this mode therefore applies the security-only filter automatically: only methods classified as security-relevant are emitted. Pass -include-non-security on the command line (or set includeNonSecurity: true in the YAML configuration file) to include all methods in the SARIF document.

      See Also:
    • GITHUB_ANNOTATIONS

      public static final OutputMode GITHUB_ANNOTATIONS
      Emits GitHub Actions workflow commands for inline PR annotations.

      Only security-relevant methods produce output. Each method becomes one ::notice or ::warning workflow command that GitHub Actions intercepts and displays as an inline annotation on the PR diff. The level is warning when ai_interaction_score >= 0.8 (potential placebo test) and notice otherwise.

      Non-security methods produce no output. This mode does not require a GitHub Advanced Security licence, unlike SARIF upload via upload-sarif.

      See Also:
  • Method Details

    • values

      public static OutputMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static OutputMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null