Class DebugReporter

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.api.debugging.DebugReporter

Direct Known Subclasses:

DebugReporterSpigot

public abstract class DebugReporter
extends Object

Represents a class that can generate a debug report.

The debug report contains general information about the system and additional debug information from IDebuggables that are registered with the DebuggableRegistry.

This class is abstract because it is meant to be extended by a platform-specific implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final IAnimatedArchitecturePlatformProvider	platformProvider

Constructor Summary

Constructors

Constructor	Description
DebugReporter(DebuggableRegistry debuggableRegistry, IAnimatedArchitecturePlatformProvider platformProvider)

Method Summary

Modifier and Type	Method	Description
protected abstract String	getAdditionalDebugReport()	Gets the additional debug report generated by the subclass.
final String	getDebugReport()	Gets the data-dump containing useful information for debugging issues.
final String	toString()

Methods inherited from class Object

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

Field Details

platformProvider

protected final IAnimatedArchitecturePlatformProvider platformProvider

Constructor Details

DebugReporter

public DebugReporter(DebuggableRegistry debuggableRegistry,
 IAnimatedArchitecturePlatformProvider platformProvider)

Method Details

getDebugReport

public final String getDebugReport()

Gets the data-dump containing useful information for debugging issues.

getAdditionalDebugReport

protected abstract String getAdditionalDebugReport()

Gets the additional debug report generated by the subclass.

Returns:

The formatted additional debug report. This is appended to the general debug report.

toString

public final String toString()

Overrides:

toString in class Object