Module aya.ij.util.text

Package com.intellij.openapi.diagnostic

Class Logger

java.lang.Object

com.intellij.openapi.diagnostic.Logger

Direct Known Subclasses:

DefaultLogger

public abstract class Logger
extends Object

A standard interface to write to %system%/log/idea.log (or %system%/testlog/idea.log in tests).

In addition to writing to log file, "error" methods result in showing "IDE fatal errors" dialog in the IDE, in EAP versions or if "idea.fatal.error.notification" system property is "true" (). See com.intellij.diagnostic.DefaultIdeaErrorLogger#canHandle for more details.

Note that in production, a call to "error" doesn't throw exceptions so the execution continues. In tests, however, an AssertionError is thrown.

In most non-performance tests, debug level is enabled by default, so that when a test fails the full contents of its log are printed to stdout.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Logger.Factory

Constructor Summary

Constructors

Constructor	Description
Logger()

Method Summary

Modifier and Type	Method	Description
boolean	assertTrue(boolean value)
boolean	assertTrue(boolean value, @Nullable Object message)
void	debug(@NotNull String message, @NotNull Object... details)
abstract void	debug(@Nullable Throwable t)
abstract void	debug(String message)
abstract void	debug(String message, @Nullable Throwable t)
void	error(Object message)
void	error(String message)
void	error(String message, @NotNull String... details)
abstract void	error(String message, @Nullable Throwable t, @NotNull String... details)
static Logger.Factory	getFactory()
static @NotNull Logger	getInstance(@NotNull Class cl)
static @NotNull Logger	getInstance(@NotNull String category)
void	info(@NotNull Throwable t)
abstract void	info(String message)
abstract void	info(String message, @Nullable Throwable t)
abstract boolean	isDebugEnabled()
static boolean	isInitialized()
boolean	isTraceEnabled()
static void	setFactory(@NotNull Class<? extends Logger.Factory> factory)
void	trace(@Nullable Throwable t)
void	trace(String message)	Log a message with 'trace' level which finer-grained than 'debug' level.
void	warn(@NotNull Throwable t)
void	warn(String message)
abstract void	warn(String message, @Nullable Throwable t)

Methods inherited from class java.lang.Object

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

Constructor Details

Logger

public Logger()

Method Details

setFactory

public static void setFactory(@NotNull
 @NotNull Class<? extends Logger.Factory> factory)

getFactory

public static Logger.Factory getFactory()

isInitialized

public static boolean isInitialized()

getInstance

@NotNull
public static @NotNull Logger getInstance(@NotNull
 @NotNull String category)

getInstance

@NotNull
public static @NotNull Logger getInstance(@NotNull
 @NotNull Class cl)

isDebugEnabled

public abstract boolean isDebugEnabled()

debug

public abstract void debug(String message)

debug

public abstract void debug(@Nullable
 @Nullable Throwable t)

debug

public abstract void debug(String message,
 @Nullable
 @Nullable Throwable t)

debug

public void debug(@NotNull
 @NotNull String message,
 @NotNull
 @NotNull Object... details)

isTraceEnabled

public boolean isTraceEnabled()

trace

public void trace(String message)

Log a message with 'trace' level which finer-grained than 'debug' level. Use this method instead of debug(String) for internal events of a subsystem to avoid overwhelming the log if 'debug' level is enabled.

trace

public void trace(@Nullable
 @Nullable Throwable t)

info

public void info(@NotNull
 @NotNull Throwable t)

info

public abstract void info(String message)

info

public abstract void info(String message,
 @Nullable
 @Nullable Throwable t)

warn

public void warn(String message)

warn

public void warn(@NotNull
 @NotNull Throwable t)

warn

public abstract void warn(String message,
 @Nullable
 @Nullable Throwable t)

error

public void error(String message)

error

public void error(Object message)

error

public void error(String message,
 @NotNull
 @NotNull String... details)

error

public abstract void error(String message,
 @Nullable
 @Nullable Throwable t,
 @NotNull
 @NotNull String... details)

assertTrue

@Contract("false,_->fail")
public boolean assertTrue(boolean value,
 @Nullable
 @Nullable Object message)

assertTrue

@Contract("false->fail")
public boolean assertTrue(boolean value)