Package picocli

Class CommandLine.Tracer

  • Enclosing class:
    CommandLine

    public static final class CommandLine.Tracer
    extends java.lang.Object
    Utility class for printing internal debug statements.
    Since:
    4.7.5
    See Also:
    CommandLine.tracer()
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void debug​(java.lang.String msg, java.lang.Object... params)
      Prints the specified message if the current trace level is DEBUG or higher.
      CommandLine.TraceLevel getLevel()
      Returns the trace level that needs to be matched or exceeded for internal tracing statements to be printed.
      void info​(java.lang.String msg, java.lang.Object... params)
      Prints the specified message if the current trace level is INFO or higher.
      boolean isDebug()
      Returns whether the current trace level is DEBUG (the highest).
      boolean isInfo()
      Returns whether the current trace level is INFO or higher.
      boolean isOff()
      Returns whether the current trace level is OFF (the lowest).
      boolean isWarn()
      Returns whether the current trace level is WARN or higher.
      void setLevel​(CommandLine.TraceLevel level)
      Sets the trace level that needs to be matched or exceeded for internal tracing statements to be printed.
      java.lang.String toString()  
      void warn​(java.lang.String msg, java.lang.Object... params)
      Prints the specified message if the current trace level is WARN or higher.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • getLevel

        public CommandLine.TraceLevel getLevel()
        Returns the trace level that needs to be matched or exceeded for internal tracing statements to be printed. The initial trace level is WARN, unless system property "picocli.trace" is set to another valid TraceLevel value.
        Returns:
        the trace level that needs to be matched or exceeded for tracing statements to be printed
      • setLevel

        public void setLevel​(CommandLine.TraceLevel level)
        Sets the trace level that needs to be matched or exceeded for internal tracing statements to be printed. The initial trace level is WARN, unless system property "picocli.trace" is set to another valid TraceLevel value.
        Parameters:
        level - the trace level that needs to be matched or exceeded for tracing statements to be printed
      • isDebug

        public boolean isDebug()
        Returns whether the current trace level is DEBUG (the highest).
      • isInfo

        public boolean isInfo()
        Returns whether the current trace level is INFO or higher.
      • isWarn

        public boolean isWarn()
        Returns whether the current trace level is WARN or higher.
      • isOff

        public boolean isOff()
        Returns whether the current trace level is OFF (the lowest).
      • warn

        public void warn​(java.lang.String msg,
                         java.lang.Object... params)
        Prints the specified message if the current trace level is WARN or higher.
        Parameters:
        msg - the message to print; may use String.format(String, Object...) syntax
        params - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.
        See Also:
        Formatter
      • info

        public void info​(java.lang.String msg,
                         java.lang.Object... params)
        Prints the specified message if the current trace level is INFO or higher.
        Parameters:
        msg - the message to print; may use String.format(String, Object...) syntax
        params - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.
        See Also:
        Formatter
      • debug

        public void debug​(java.lang.String msg,
                          java.lang.Object... params)
        Prints the specified message if the current trace level is DEBUG or higher.
        Parameters:
        msg - the message to print; may use String.format(String, Object...) syntax
        params - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.
        See Also:
        Formatter
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object