co.aikar.timings

Interface TimingsFactory

public interface TimingsFactory

A factory for the required implementation of Timings.

Method Summary

Modifier and Type	Method and Description
void	generateReport(CommandSource source) Generates a report and sends to the given source.
void	generateReport(MessageChannel channel) Generates a report and sends to the given channel.
int	getHistoryInterval() Gets the history interval.
int	getHistoryLength() Gets the history length.
boolean	isTimingsEnabled() Gets whether the timing system is enabled.
boolean	isVerboseTimingsEnabled() Gets whether verbose mode is enabled.
Timing	of(Object plugin, String name, Timing groupHandler) Gets or creates a timing instance for the plugin with the given name.
void	reset() Resets the timing data.
void	setHistoryInterval(int interval) Sets the history interval.
void	setHistoryLength(int length) Sets the history length.
void	setTimingsEnabled(boolean enabled) Sets whether the timing system is enabled.
void	setVerboseTimingsEnabled(boolean enabled) Sets whether verbose mode is enabled.

Method Detail

of

Timing of(Object plugin,
          String name,
          @Nullable
          Timing groupHandler)

Gets or creates a timing instance for the plugin with the given name.

Parameters:

plugin - Plugin owning the timing

name - Name of the timing

groupHandler - The handler, can be null for no parent

Returns:

A timing instance

isTimingsEnabled

boolean isTimingsEnabled()

Gets whether the timing system is enabled.

Returns:

Whether enabled

setTimingsEnabled

void setTimingsEnabled(boolean enabled)

Sets whether the timing system is enabled.

Parameters:

enabled - Is enabled or not

isVerboseTimingsEnabled

boolean isVerboseTimingsEnabled()

Gets whether verbose mode is enabled.

Returns:

Whether verbose mode is enabled

setVerboseTimingsEnabled

void setVerboseTimingsEnabled(boolean enabled)

Sets whether verbose mode is enabled.

Parameters:

enabled - Is enabled

getHistoryInterval

int getHistoryInterval()

Gets the history interval.

Returns:

The history interval in ticks

setHistoryInterval

void setHistoryInterval(int interval)

Sets the history interval.

Parameters:

interval - The interval in ticks

getHistoryLength

int getHistoryLength()

Gets the history length.

Returns:

History length

setHistoryLength

void setHistoryLength(int length)

Sets the history length.

Parameters:

length - History length

reset

void reset()

Resets the timing data.

generateReport

void generateReport(@Nullable
                    CommandSource source)

Generates a report and sends to the given source.

Parameters:

source - Source to send to, null for console source

generateReport

void generateReport(MessageChannel channel)

Generates a report and sends to the given channel.

Parameters:

channel - Channel to send to