Package ch.njol.skript.log

Class SkriptLogger

java.lang.Object

ch.njol.skript.log.SkriptLogger

public abstract class SkriptLogger
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static Level	DEBUG
static Logger	LOGGER
static Level	SEVERE

Constructor Summary

Constructors

Constructor	Description
SkriptLogger()

Method Summary

Modifier and Type	Method	Description
static boolean	debug()
static @Nullable Node	getNode()
static void	log(@Nullable LogEntry entry)
static boolean	log(Verbosity minVerb)	Checks whether messages should be logged for the given verbosity.
static void	log(Level level, String message)	Logging should be done like this:
static void	logAll(Collection<LogEntry> entries)
static void	logTracked(Level level, String message, ErrorQuality quality)
static void	setNode(@Nullable Node node)
static void	setVerbosity(Verbosity v)
static <T extends LogHandler> T	startLogHandler(T h)	Starts a log handler.
static ParseLogHandler	startParseLogHandler()	Shorthand for startLogHandler(new ParseLogHandler());
static RetainingLogHandler	startRetainingLog()	Shorthand for startLogHandler(new RetainingLogHandler());

Methods inherited from class java.lang.Object

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

Field Details

SEVERE

public static final Level SEVERE

DEBUG

public static final Level DEBUG

LOGGER

public static final Logger LOGGER

Constructor Details

SkriptLogger

public SkriptLogger()

Method Details

startRetainingLog

public static RetainingLogHandler startRetainingLog()

Shorthand for startLogHandler(new RetainingLogHandler());

Returns:

A newly created RetainingLogHandler

startParseLogHandler

public static ParseLogHandler startParseLogHandler()

Shorthand for startLogHandler(new ParseLogHandler());

Returns:

A newly created ParseLogHandler

startLogHandler

public static <T extends LogHandler> T startLogHandler(T h)

Starts a log handler.

This should be used like this:

 try (LogHandler handler = SkriptLogger.startLogHandler(new ...LogHandler())) {
        doSomethingThatLogsMessages();
        // do something with the logged messages
 }
 

Returns:

The passed LogHandler

See Also:

startParseLogHandler(), startRetainingLog(), BlockingLogHandler, CountingLogHandler, ErrorDescLogHandler, FilteringLogHandler, RedirectingLogHandler

setVerbosity

public static void setVerbosity(Verbosity v)

debug

public static boolean debug()

setNode

public static void setNode(@Nullable Node node)

getNode

public static @Nullable Node getNode()

log

public static void log(Level level,
 String message)

Logging should be done like this:

 if (Skript.logNormal())
        Skript.info("this information is displayed on verbosity normal or higher");
 

Parameters:

level -

message -

See Also:

Skript.info(String), Skript.warning(String), Skript.error(String), Skript.logNormal(), Skript.logHigh(), Skript.logVeryHigh(), Skript.debug()

log

public static void log(@Nullable LogEntry entry)

logAll

public static void logAll(Collection<LogEntry> entries)

logTracked

public static void logTracked(Level level,
 String message,
 ErrorQuality quality)

log

public static boolean log(Verbosity minVerb)

Checks whether messages should be logged for the given verbosity.

Parameters:

minVerb - minimal verbosity

Returns:

Whether messages should be logged for the given verbosity.