com.comphenix.protocol.error

Class Report.ReportBuilder

java.lang.Object

com.comphenix.protocol.error.Report.ReportBuilder

Enclosing class:

Report

public static class Report.ReportBuilder
extends java.lang.Object

Must be constructed through the factory method in Report.

Method Summary

Methods

Modifier and Type	Method and Description
Report	build() Construct a new report with the provided input.
Report.ReportBuilder	callerParam(java.lang.Object... callerParameters) Set the parameters in the caller method.
Report.ReportBuilder	error(java.lang.Throwable exception) Set the current exception that occured.
Report.ReportBuilder	messageParam(java.lang.Object... messageParameters) Set the message parameters that are used to construct a message text.
Report.ReportBuilder	type(ReportType type) Set the current report type.

Methods inherited from class java.lang.Object

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

Method Detail

type

public Report.ReportBuilder type(ReportType type)

Set the current report type. Cannot be NULL.

Parameters:

type - - report type.

Returns:

This builder, for chaining.

error

public Report.ReportBuilder error(@Nullable
                         java.lang.Throwable exception)

Set the current exception that occured.

Parameters:

exception - - exception that occured.

Returns:

This builder, for chaining.

messageParam

public Report.ReportBuilder messageParam(@Nullable
                                java.lang.Object... messageParameters)

Set the message parameters that are used to construct a message text.

Parameters:

messageParameters - - parameters for the report type.

Returns:

This builder, for chaining.

callerParam

public Report.ReportBuilder callerParam(@Nullable
                               java.lang.Object... callerParameters)

Set the parameters in the caller method. This is optional.

Parameters:

callerParameters - - parameters of the caller method.

Returns:

This builder, for chaining.

build

public Report build()

Construct a new report with the provided input.

Returns:

A new report.