com.comphenix.protocol.error

Class Report

java.lang.Object

com.comphenix.protocol.error.Report

public class Report
extends java.lang.Object

Represents a error or warning report.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Report.ReportBuilder Must be constructed through the factory method in Report.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Report(ReportType type, java.lang.Throwable exception, java.lang.Object[] messageParameters, java.lang.Object[] callerParameters) Construct a new report with the given type and parameters.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object[]	getCallerParameters() Retrieve the parameters of the caller method.
java.lang.Throwable	getException() Retrieve the associated exception, or NULL if not found.
java.lang.Object[]	getMessageParameters() Retrieve the message parameters that will be used to construc the report message.
java.lang.String	getReportMessage() Format the current report type with the provided message parameters.
ReportType	getType() Retrieve the report type.
boolean	hasCallerParameters() Determine if we have any caller parameters.
boolean	hasMessageParameters() Determine if we have any message parameters.
static Report.ReportBuilder	newBuilder(ReportType type) Construct a new report builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Report

protected Report(ReportType type,
      @Nullable
      java.lang.Throwable exception,
      @Nullable
      java.lang.Object[] messageParameters,
      @Nullable
      java.lang.Object[] callerParameters)

Construct a new report with the given type and parameters.

Parameters:

exception - - exception that occured in the caller method.

type - - the report type that will be used to construct the message.

messageParameters - - parameters used to construct the report message.

callerParameters - - parameters from the caller method.

Method Detail

newBuilder

public static Report.ReportBuilder newBuilder(ReportType type)

Construct a new report builder.

Parameters:

type - - the initial report type.

Returns:

Report builder.

getReportMessage

public java.lang.String getReportMessage()

Format the current report type with the provided message parameters.

Returns:

The formated report message.

getMessageParameters

public java.lang.Object[] getMessageParameters()

Retrieve the message parameters that will be used to construc the report message.

Returns:

Message parameters.

getCallerParameters

public java.lang.Object[] getCallerParameters()

Retrieve the parameters of the caller method. Optional - may be NULL.

Returns:

Parameters or the caller method.

getType

public ReportType getType()

Retrieve the report type.

Returns:

Report type.

getException

public java.lang.Throwable getException()

Retrieve the associated exception, or NULL if not found.

Returns:

Associated exception, or NULL.

hasMessageParameters

public boolean hasMessageParameters()

Determine if we have any message parameters.

Returns:

TRUE if there are any message parameters, FALSE otherwise.

hasCallerParameters

public boolean hasCallerParameters()

Determine if we have any caller parameters.

Returns:

TRUE if there are any caller parameters, FALSE otherwise.