Package org.sosy_lab.common.log

Enum TestLogManager

    • Enum Constant Detail

    • Method Detail

      • values

        public static TestLogManager[] values()
        Deprecated.
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (TestLogManager c : TestLogManager.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static TestLogManager valueOf​(String name)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null

      • getInstance

        public static LogManager getInstance()
        Deprecated.

      • withComponentName

        @CanIgnoreReturnValue
public LogManager withComponentName​(String pName)
        Deprecated.
        Description copied from interface: LogManager
        Returns a new LogManager instance which may use the given name as an indicator from which component a log message comes from.
        Specified by:
        withComponentName in interface LogManager
        Parameters:
        pName - A non-empty string.
        Returns:
        A LogManager instance.

      • wouldBeLogged

        public boolean wouldBeLogged​(Level pPriority)
        Deprecated.
        Description copied from interface: LogManager
        Returns true if a message with the given log level would be logged.
        Specified by:
        wouldBeLogged in interface LogManager
        Parameters:
        pPriority - the log level
        Returns:
        whether this log level is enabled

      • log

        public void log​(Level pPriority,
                Object... pArgs)
        Deprecated.
        Description copied from interface: LogManager
        Logs any message occurring during program execution. The message is constructed lazily by concatenating the parts with " ". The caller should not use string concatenation to create the message in order to increase performance if the message is never logged. To make individual arguments lazy, use MoreStrings.lazyString(Supplier).
        Specified by:
        log in interface LogManager
        Parameters:
        pPriority - the log level for the message
        pArgs - the parts of the message (can be an arbitrary number of objects whose Object.toString() method is called)

      • log

        public void log​(Level pPriority,
                Supplier<String> pMsgSupplier)
        Deprecated.
        Description copied from interface: LogManager
        Logs any message occurring during program execution. The message is constructed lazily by asking the provided supplier if necessary.
        Specified by:
        log in interface LogManager
        Parameters:
        pPriority - the log level for the message
        pMsgSupplier - a supplier for a non-null log message

      • logf

        @FormatMethod
public void logf​(Level pPriority,
                 String pFormat,
                 Object... pArgs)
        Deprecated.
        Description copied from interface: LogManager
        Logs any message occurring during program execution. The message is constructed lazily from String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).
        Specified by:
        logf in interface LogManager
        Parameters:
        pPriority - the log level for the message
        pFormat - The format string.
        pArgs - The arguments for the format string.

      • logUserException

        public void logUserException​(Level pPriority,
                             Throwable pE,
                             @Nullable String pAdditionalMessage)
        Deprecated.
        Description copied from interface: LogManager
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden from the user and logged with a lower log level.

        Use this method in cases where an expected exception with a useful error message is thrown, e.g. an InvalidConfigurationException.

        If you want to log an IOException because of a write error, it is recommended to write the message like "Could not write FOO to file". The final message will then be "Could not write FOO to file FOO.txt (REASON)".

        Specified by:
        logUserException in interface LogManager
        Parameters:
        pPriority - the log level for the message
        pE - the occurred exception
        pAdditionalMessage - an optional message

      • logfUserException

        @FormatMethod
public void logfUserException​(Level pPriority,
                              Throwable pE,
                              String pFormat,
                              Object... pArgs)
        Deprecated.
        Description copied from interface: LogManager
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden from the user and logged with a lower log level.

        Use this method in cases where an expected exception with a useful error message is thrown, e.g. an InvalidConfigurationException.

        The message is constructed lazily from String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).

        If you want to log an IOException because of a write error, it is recommended to write the message like "Could not write FOO to file". The final message will then be "Could not write FOO to file FOO.txt (REASON)".

        Specified by:
        logfUserException in interface LogManager
        Parameters:
        pPriority - the log level for the message
        pE - the occurred exception
        pFormat - The format string.
        pArgs - The arguments for the format string.

      • logDebugException

        public void logDebugException​(Throwable pE,
                              @Nullable String pAdditionalMessage)
        Deprecated.
        Description copied from interface: LogManager
        Log an exception solely for the purpose of debugging. In default configuration, this exception is not shown to the user!

        Use this method when you want to log an exception that was handled by the catching site, but you don't want to forget the information completely.

        Specified by:
        logDebugException in interface LogManager
        Parameters:
        pE - the occurred exception
        pAdditionalMessage - an optional message

      • logfDebugException

        @FormatMethod
public void logfDebugException​(Throwable pE,
                               String pFormat,
                               Object... pArgs)
        Deprecated.
        Description copied from interface: LogManager
        Log an exception solely for the purpose of debugging. In default configuration, this exception is not shown to the user!

        Use this method when you want to log an exception that was handled by the catching site, but you don't want to forget the information completely.

        The message is constructed lazily from String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).

        Specified by:
        logfDebugException in interface LogManager
        Parameters:
        pE - the occurred exception
        pFormat - The format string.
        pArgs - The arguments for the format string.

      • logDebugException

        public void logDebugException​(Throwable pE)
        Deprecated.
        Description copied from interface: LogManager
        Log an exception solely for the purpose of debugging. In default configuration, this exception is not shown to the user!

        Use this method when you want to log an exception that was handled by the catching site, but you don't want to forget the information completely.

        Specified by:
        logDebugException in interface LogManager
        Parameters:
        pE - the occurred exception

      • logException

        public void logException​(Level pPriority,
                         Throwable pE,
                         @Nullable String pAdditionalMessage)
        Deprecated.
        Description copied from interface: LogManager
        Log an exception by printing the full details to the user.

        This method should only be used in cases where logUserException and logDebugException are not acceptable.

        Specified by:
        logException in interface LogManager
        Parameters:
        pPriority - the log level for the message
        pE - the occurred exception
        pAdditionalMessage - an optional message

      • logfException

        @FormatMethod
public void logfException​(Level pPriority,
                          Throwable pE,
                          String pFormat,
                          Object... pArgs)
        Deprecated.
        Description copied from interface: LogManager
        Log an exception by printing the full details to the user.

        This method should only be used in cases where logUserException and logDebugException are not acceptable.

        The message is constructed lazily from String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).

        Specified by:
        logfException in interface LogManager
        Parameters:
        pPriority - the log level for the message
        pE - the occurred exception
        pFormat - The format string.
        pArgs - The arguments for the format string.

      • flush

        public void flush()
        Deprecated.
        Description copied from interface: LogManager
        Flush all handlers of this logger.
        Specified by:
        flush in interface LogManager