com.frostdeveloper.api.handler

Class Report

java.lang.Object

com.frostdeveloper.api.handler.Report

public class Report
extends Object

A class used to handle exception reporting and logs our caught exception to a file.

Since:

1.0.0

Author:

OMGitzFROST

Constructor Summary

Constructors

Constructor and Description
Report(File output) A constructor used to establish our file output for our report log.
Report(Path path) A constructor used to establish our file output for our report log.
Report(String path) A constructor used to establish our file output for our report log.

Method Summary

Modifier and Type	Method and Description
void	create(@NotNull Throwable thrown) A method used to create our report.
void	create(@NotNull Throwable thrown, boolean silent) A method used to create our report with an option to specify if the stacktrace should be silent.

Methods inherited from class java.lang.Object

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

Constructor Detail

Report

public Report(File output)

A constructor used to establish our file output for our report log.

Parameters:

output - Output file

Since:

1.0.0

Report

public Report(String path)

A constructor used to establish our file output for our report log.

Parameters:

path - Output file path

Since:

1.0.0

Report

public Report(Path path)

A constructor used to establish our file output for our report log.

Parameters:

path - Output file path

Since:

1.0.0

Method Detail

create

public void create(@NotNull
                   @NotNull Throwable thrown,
                   boolean silent)

A method used to create our report with an option to specify if the stacktrace should be silent. A silent stacktrace simply means that the stack will not print the console but will still appear in the report file. And vice versa, if not silent the exception will print in both the report and the console.

Parameters:

thrown - Exception caught

silent - Whether the stacktrace should print silently.

Since:

1.0.0

See Also:

create(Throwable)

create

public void create(@NotNull
                   @NotNull Throwable thrown)

A method used to create our report. By default, this method will not print the exception's stacktrace silently, to print silently; please see create(Throwable, boolean).

Parameters:

thrown - Exception caught

Since:

1.0.0

See Also:

create(Throwable, boolean)