Package org.apache.maven.jline

Class MessageUtils

  • public class MessageUtils
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      MessageUtils()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void awaitTerminalInitialization()
      Waits for the terminal to finish installing on its background thread.
      static org.apache.maven.message.MessageBuilder builder()  
      static org.jline.terminal.Terminal getTerminal()  
      static int getTerminalWidth()  
      static boolean isColorEnabled()  
      static void registerShutdownHook()  
      static void setColorEnabled​(boolean enabled)  
      static java.lang.String stripAnsiCodes​(java.lang.String msg)
      Remove any ANSI code from a message (colors or other escape sequences).
      static void systemInstall()  
      static void systemInstall​(java.util.function.Consumer<org.jline.terminal.TerminalBuilder> builderConsumer, java.util.function.Consumer<org.jline.terminal.Terminal> terminalConsumer)  
      static void systemInstall​(org.jline.terminal.Terminal terminal)  
      static void systemUninstall()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MessageUtils

        public MessageUtils()

    • Method Detail

      • systemInstall

        public static void systemInstall​(org.jline.terminal.Terminal terminal)

      • systemInstall

        public static void systemInstall()

      • systemInstall

        public static void systemInstall​(java.util.function.Consumer<org.jline.terminal.TerminalBuilder> builderConsumer,
                                 java.util.function.Consumer<org.jline.terminal.Terminal> terminalConsumer)

      • awaitTerminalInitialization

        public static void awaitTerminalInitialization()
        Waits for the terminal to finish installing on its background thread.

        Terminal setup runs asynchronously and replaces System.out/System.err along the way. Call this before you redirect those streams yourself (for example for the -l log file), otherwise the late terminal install can overwrite your redirection and logs end up back on the console.

      • registerShutdownHook

        public static void registerShutdownHook()

      • systemUninstall

        public static void systemUninstall()

      • setColorEnabled

        public static void setColorEnabled​(boolean enabled)

      • isColorEnabled

        public static boolean isColorEnabled()

      • getTerminalWidth

        public static int getTerminalWidth()

      • builder

        public static org.apache.maven.message.MessageBuilder builder()

      • getTerminal

        public static org.jline.terminal.Terminal getTerminal()

      • stripAnsiCodes

        public static java.lang.String stripAnsiCodes​(java.lang.String msg)
        Remove any ANSI code from a message (colors or other escape sequences).
        Parameters:
        msg - message eventually containing ANSI codes
        Returns:
        the message with ANSI codes removed