com.comphenix.protocol.error

Class ReportType

java.lang.Object

com.comphenix.protocol.error.ReportType

public class ReportType
extends Object

Represents a strongly-typed report. Subclasses should be immutable.

By convention, a report must be declared as a static field publicly accessible from the sender class.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected String	reportName

Constructor Summary

Constructors

Constructor and Description
ReportType(String errorFormat) Construct a new report type.

Method Summary

Modifier and Type	Method and Description
String	getMessage(Object[] parameters) Convert the given report to a string, using the provided parameters.
static String	getReportName(Object sender, ReportType type) Retrieve the full canonical name of a given report type.
static ReportType[]	getReports(Class<?> sender) Retrieve all publicly associated reports.
static Class<?>	getSenderClass(Object sender) Retrieve the class of the given sender.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

reportName

protected String reportName

Constructor Detail

ReportType

public ReportType(String errorFormat)

Construct a new report type.

Parameters:

errorFormat - - string used to format the underlying report.

Method Detail

getMessage

public String getMessage(Object[] parameters)

Convert the given report to a string, using the provided parameters.

Parameters:

parameters - - parameters to insert, or NULL to insert nothing.

Returns:

The full report in string format.

toString

public String toString()

Overrides:

toString in class Object

getSenderClass

public static Class<?> getSenderClass(Object sender)

Retrieve the class of the given sender.

If the sender is already a Class, we return it.

Parameters:

sender - - the sender to look up.

Returns:

The class of the sender.

getReportName

public static String getReportName(Object sender,
                                   ReportType type)

Retrieve the full canonical name of a given report type.

Note that the sender may be a class (for static callers), in which case it will be used directly instead of its getClass() method.

It is thus not advisable for class classes to report reports.

Parameters:

sender - - the sender, or its class.

type - - the report type.

Returns:

The full canonical name.

getReports

public static ReportType[] getReports(Class<?> sender)

Retrieve all publicly associated reports.

Parameters:

sender - - sender class.

Returns:

All associated reports.