Module com.github.cowwoc.requirements10.java
Package com.github.cowwoc.requirements10.java

Interface GlobalConfiguration

public interface GlobalConfiguration
The configuration shared by all validators. Changes apply to existing or new validators.

Thread-safety: Implementations must be thread-safe.

  • Method Details

    • supportedTerminalEncodings

      Set<TerminalEncoding> supportedTerminalEncodings()
      Returns the encoding supported by the terminal.
      Returns:
      the encoding supported by the terminal

    • terminalEncoding

      TerminalEncoding terminalEncoding()
      Returns the current terminal encoding.
      Returns:
      the current terminal encoding (defaults to the auto-detected encoding)

    • terminalEncoding

      GlobalConfiguration terminalEncoding(TerminalEncoding encoding)
      Sets the terminal encoding of the output.

      This can be used to force the use of ANSI colors when their support is not detected.

      Parameters:
      encoding - the type of encoding that the terminal supports
      Returns:
      this
      Throws:
      NullPointerException - if encoding is null