Package io.github.thebusybiscuit.slimefun4.api

Class ErrorReport<T extends Throwable>

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.ErrorReport<T>

Type Parameters:

T - The type of Throwable which has spawned this ErrorReport

public class ErrorReport<T extends Throwable>
extends Object

This class represents an ErrorReport. Error reports are thrown when a BlockTicker is causing problems. To ensure that the console doesn't get too spammy, we destroy the block and generate an ErrorReport instead. Error reports get saved in the plugin folder.

Author:

TheBusyBiscuit

Constructor Summary

Constructors

Constructor	Description
ErrorReport(T throwable, SlimefunItem item)	This constructs a new ErrorReport for the given SlimefunItem.
ErrorReport(T throwable, SlimefunAddon addon, Consumer<PrintStream> printer)	This is the base constructor for an ErrorReport.
ErrorReport(T throwable, Location l, SlimefunItem item)	This constructs a new ErrorReport for the given Location and SlimefunItem.

Method Summary

Modifier and Type	Method	Description
static int	count()	This method returns the amount of ErrorReports created in this session.
File	getFile()	This method returns the File this ErrorReport has been written to.
T	getThrown()	This returns the Throwable that was thrown.
static void	tryCatch(Function<Exception,ErrorReport<Exception>> function, Runnable runnable)	This helper method wraps the given Runnable into a try-catch block.

Methods inherited from class java.lang.Object

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

Constructor Details

ErrorReport

@ParametersAreNonnullByDefault
public ErrorReport(T throwable,
 SlimefunAddon addon,
 Consumer<PrintStream> printer)

This is the base constructor for an ErrorReport. It will only print the necessary info and provides a Consumer for any more detailed needs.

Parameters:

throwable - The Throwable which caused this ErrorReport.

addon - The SlimefunAddon responsible.

printer - A custom Consumer to add more details.

ErrorReport

@ParametersAreNonnullByDefault
public ErrorReport(T throwable,
 Location l,
 SlimefunItem item)

This constructs a new ErrorReport for the given Location and SlimefunItem.

Parameters:

throwable - The Throwable which caused this ErrorReport.

l - The Location at which the error was thrown.

item - The SlimefunItem responsible.

ErrorReport

@ParametersAreNonnullByDefault
public ErrorReport(T throwable,
 SlimefunItem item)

This constructs a new ErrorReport for the given SlimefunItem.

Parameters:

throwable - The Throwable which caused this ErrorReport.

item - The SlimefunItem responsible.

Method Details

getFile

@Nonnull
public File getFile()

This method returns the File this ErrorReport has been written to.

Returns:

The File for this ErrorReport

getThrown

@Nonnull
public T getThrown()

This returns the Throwable that was thrown.

Returns:

The Throwable

count

public static int count()

This method returns the amount of ErrorReports created in this session.

Returns:

The amount of ErrorReports created.

tryCatch

public static void tryCatch(@Nonnull
 Function<Exception,ErrorReport<Exception>> function,
 @Nonnull
 Runnable runnable)

This helper method wraps the given Runnable into a try-catch block. When an Exception occurs, a new ErrorReport will be generated using the provided Function.

Parameters:

function - The Function to generate a new ErrorReport

runnable - The code to execute