Class Diag

java.lang.Object
org.jline.terminal.impl.Diag

public class Diag extends Object
Diagnostic utility for JLine terminals.

The Diag class provides diagnostic tools for analyzing and troubleshooting JLine terminal configurations. It can be used to gather information about the current environment, available terminal providers, system properties, and other details relevant to terminal operation.

This class can be run as a standalone application to generate a diagnostic report, which is useful for debugging terminal-related issues. The report includes information such as:

  • Java version and system properties
  • Operating system details
  • Available terminal providers
  • Terminal capabilities and attributes
  • Console and TTY information

The diagnostic information can help identify configuration issues, missing dependencies, or platform-specific problems that might affect terminal functionality.

  • Constructor Details

    • Diag

      public Diag(PrintStream out, boolean verbose)
  • Method Details

    • main

      public static void main(String[] args)
      Main entry point for running the diagnostic tool.

      This method runs the diagnostic tool and prints the results to standard output. If the "--verbose" flag is provided as an argument, additional detailed information will be included in the output.

      Parameters:
      args - command-line arguments (use "--verbose" for detailed output)
    • diag

      public static void diag(PrintStream out)
      Generates a diagnostic report with standard verbosity.

      This method generates a diagnostic report with standard verbosity and writes it to the specified PrintStream. This is equivalent to calling diag(PrintStream, boolean) with verbose=false.

      Parameters:
      out - the PrintStream to write the diagnostic report to
    • diag

      public static void diag(PrintStream out, boolean verbose)
    • run

      public void run()