Package org.skriptlang.skript.log.runtime

Class RuntimeErrorFilter

java.lang.Object

org.skriptlang.skript.log.runtime.RuntimeErrorFilter

public class RuntimeErrorFilter
extends Object

Handles filtering of runtime errors based on their level and predefined limits. Uses the concept of 'frames' to track the number of errors and warnings that are allowed in a given period. Use test(RuntimeError) to determine if a runtime error should be printed or not. Printing the frame outputs can be done via getErrorFrame() and getWarningFrame().

Field Summary

Fields

Modifier and Type	Field	Description
static final RuntimeErrorFilter	NO_FILTER	A filter that does not filter anything, allowing all errors and warnings to be printed.

Constructor Summary

Constructors

Constructor	Description
RuntimeErrorFilter(Frame.FrameLimit errorFrameLimits, Frame.FrameLimit warningFrameLimits)

Method Summary

Modifier and Type	Method	Description
Frame	getErrorFrame()
Frame	getWarningFrame()
void	setErrorFrameLimits(Frame.FrameLimit limits)
void	setWarningFrameLimits(Frame.FrameLimit limits)
boolean	test(@NotNull RuntimeError error)	Tests whether a runtime error should be printed or not.

Methods inherited from class java.lang.Object

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

Field Details

NO_FILTER

public static final RuntimeErrorFilter NO_FILTER

A filter that does not filter anything, allowing all errors and warnings to be printed. Modifications to its limits will do nothing, and the returned frames will hold no relevant data.

Constructor Details

RuntimeErrorFilter

public RuntimeErrorFilter(Frame.FrameLimit errorFrameLimits,
 Frame.FrameLimit warningFrameLimits)

Method Details

test

public boolean test(@NotNull
 @NotNull RuntimeError error)

Tests whether a runtime error should be printed or not.

Parameters:

error - True if it should be printed, false if not.

setErrorFrameLimits

public void setErrorFrameLimits(Frame.FrameLimit limits)

setWarningFrameLimits

public void setWarningFrameLimits(Frame.FrameLimit limits)

getErrorFrame

public Frame getErrorFrame()

Returns:

The frame containing emitted errors.

getWarningFrame

public Frame getWarningFrame()

Returns:

The frame containing emitted warnings.