Package org.skriptlang.skript.log.runtime

Class RuntimeErrorManager

java.lang.Object

org.skriptlang.skript.log.runtime.RuntimeErrorManager

All Implemented Interfaces:

Closeable, AutoCloseable

public class RuntimeErrorManager
extends Object
implements Closeable

Handles passing runtime errors between producers and consumers via a frame collection system.
The manager should be treated as a singleton and accessed via getInstance() or Skript.getRuntimeErrorManager(). Changing the frame length or limits requires edits to the SkriptConfig values and a call to refresh(). Reloading the config will automatically call refresh().

See Also:

• RuntimeErrorConsumer
• RuntimeErrorProducer
• Frame

Constructor Summary

Constructors

Constructor	Description
RuntimeErrorManager(long frameLength)	Creates a new error manager, which also creates its own frames.

Method Summary

Modifier and Type	Method	Description
void	addConsumer(RuntimeErrorConsumer consumer)	Adds a RuntimeErrorConsumer that will receive the emitted errors and frame output data.
void	addConsumers(RuntimeErrorConsumer... newConsumers)	Adds multiple RuntimeErrorConsumers that will receive the emitted errors and frame output data.
void	close()
void	error(@NotNull RuntimeError error)	Emits a warning or error depending on severity.
Frame	getErrorFrame()	Deprecated, for removal: This API element is subject to removal in a future version. RuntimeErrorFilter.getErrorFrame()
static RuntimeErrorManager	getInstance()	Prefer using Skript.getRuntimeErrorManager() instead.
Frame	getWarningFrame()	Deprecated, for removal: This API element is subject to removal in a future version. RuntimeErrorFilter.getWarningFrame()
static void	refresh()	Refreshes the runtime error manager for Skript, pulling from the config values.
List<RuntimeErrorConsumer>	removeAllConsumers()	Removes all RuntimeErrorConsumers that receive emitted errors and frame output data.
boolean	removeConsumer(RuntimeErrorConsumer consumer)	Removes a RuntimeErrorConsumer from the tracked list.

Methods inherited from class java.lang.Object

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

Constructor Details

RuntimeErrorManager

public RuntimeErrorManager(long frameLength)

Creates a new error manager, which also creates its own frames.
Must be closed when no longer being used.

Parameters:

frameLength - The length of a frame in ticks.

Method Details

getInstance

@Internal
public static RuntimeErrorManager getInstance()

Prefer using Skript.getRuntimeErrorManager() instead.

Returns:

The singleton instance of the runtime error manager.

refresh

public static void refresh()

Refreshes the runtime error manager for Skript, pulling from the config values. Tracked consumers are maintained during refreshes.

error

public void error(@NotNull
 @NotNull RuntimeError error)

Emits a warning or error depending on severity.

Parameters:

error - The error to emit.

getErrorFrame

@Deprecated(since="2.13",
            forRemoval=true)
public Frame getErrorFrame()

Deprecated, for removal: This API element is subject to removal in a future version.

RuntimeErrorFilter.getErrorFrame()

Returns:

The frame containing emitted errors.

getWarningFrame

@Deprecated(since="2.13",
            forRemoval=true)
public Frame getWarningFrame()

Deprecated, for removal: This API element is subject to removal in a future version.

RuntimeErrorFilter.getWarningFrame()

Returns:

The frame containing emitted warnings.

addConsumer

public void addConsumer(RuntimeErrorConsumer consumer)

Adds a RuntimeErrorConsumer that will receive the emitted errors and frame output data. Consumers will be maintained when the manager is refreshed.

Parameters:

consumer - The consumer to add.

addConsumers

public void addConsumers(RuntimeErrorConsumer... newConsumers)

Adds multiple RuntimeErrorConsumers that will receive the emitted errors and frame output data. Consumers will be maintained when the manager is refreshed.

Parameters:

newConsumers - The RuntimeErrorConsumers to add.

removeConsumer

public boolean removeConsumer(RuntimeErrorConsumer consumer)

Removes a RuntimeErrorConsumer from the tracked list.

Parameters:

consumer - The consumer to remove.

Returns:

true If the consumer was removed.

removeAllConsumers

public List<RuntimeErrorConsumer> removeAllConsumers()

Removes all RuntimeErrorConsumers that receive emitted errors and frame output data.

Returns:

All RuntimeErrorConsumers removed.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable