Package org.skriptlang.skript.log.runtime

Class RuntimeErrorCatcher

java.lang.Object

org.skriptlang.skript.log.runtime.RuntimeErrorCatcher

All Implemented Interfaces:

RuntimeErrorConsumer

public class RuntimeErrorCatcher
extends Object
implements RuntimeErrorConsumer

A RuntimeErrorConsumer to be used in RuntimeErrorManager to catch RuntimeErrors. This should always be used with start() and stop().

Constructor Summary

Constructors

Constructor	Description
RuntimeErrorCatcher()

Method Summary

Modifier and Type	Method	Description
RuntimeErrorCatcher	clearCachedErrors()	Clear all cached RuntimeErrors.
@UnmodifiableView List<RuntimeError>	getCachedErrors()	Gets all the cached RuntimeErrors.
@Nullable RuntimeErrorFilter	getFilter()
void	printError(RuntimeError error)	Prints a single error with all its information.
void	printFrameOutput(Frame.FrameOutput output, Level level)	Prints the output of a frame, including skipped errors, timeouts, and whatever other information required.
RuntimeErrorCatcher	start()	Starts this RuntimeErrorCatcher, removing all RuntimeErrorConsumers from RuntimeErrorManager and storing them in storedConsumers.
void	stop()	Stops this RuntimeErrorCatcher, removing from RuntimeErrorManager and restoring the previous RuntimeErrorConsumers from storedConsumers.

Methods inherited from class java.lang.Object

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

Constructor Details

RuntimeErrorCatcher

public RuntimeErrorCatcher()

Method Details

getFilter

@Nullable
public @Nullable RuntimeErrorFilter getFilter()

Specified by:

getFilter in interface RuntimeErrorConsumer

Returns:

The filter to use when checking if this consumer should print an error. Defaults to the standard config-driven filter. If no filter should be used, return RuntimeErrorFilter.NO_FILTER. This value MUST be effectively final.

start

public RuntimeErrorCatcher start()

Starts this RuntimeErrorCatcher, removing all RuntimeErrorConsumers from RuntimeErrorManager and storing them in storedConsumers. Makes this RuntimeErrorCatcher the only RuntimeErrorConsumer in RuntimeErrorManager to catch RuntimeErrors.

Returns:

This RuntimeErrorCatcher

stop

public void stop()

Stops this RuntimeErrorCatcher, removing from RuntimeErrorManager and restoring the previous RuntimeErrorConsumers from storedConsumers. Prints all cached RuntimeErrors, cachedErrors.

getCachedErrors

public @UnmodifiableView List<RuntimeError> getCachedErrors()

Gets all the cached RuntimeErrors.

clearCachedErrors

public RuntimeErrorCatcher clearCachedErrors()

Clear all cached RuntimeErrors.

printError

public void printError(RuntimeError error)

Description copied from interface: RuntimeErrorConsumer

Prints a single error with all its information.

Specified by:

printError in interface RuntimeErrorConsumer

Parameters:

error - The error to print.

printFrameOutput

public void printFrameOutput(Frame.FrameOutput output,
 Level level)

Description copied from interface: RuntimeErrorConsumer

Prints the output of a frame, including skipped errors, timeouts, and whatever other information required.

Specified by:

printFrameOutput in interface RuntimeErrorConsumer

Parameters:

output - An output object containing unmodifiable views of the frame data.

level - The severity of this frame (error vs warning).