Class TimedRegisteredListener

java.lang.Object

org.bukkit.plugin.RegisteredListener

org.bukkit.plugin.TimedRegisteredListener

public class TimedRegisteredListener
extends RegisteredListener

Extends RegisteredListener to include timing information

Since:

1.1.0

Constructor Summary

Constructors

Constructor	Description
TimedRegisteredListener(@NotNull Listener pluginListener, @NotNull EventExecutor eventExecutor, @NotNull EventPriority eventPriority, @NotNull Plugin registeredPlugin, boolean listenCancelled)

Method Summary

Modifier and Type	Method	Description
void	callEvent(@NotNull Event event)	Calls the event executor
int	getCount()	Gets the total times this listener has been called
@Nullable Class<? extends Event>	getEventClass()	Gets the class of the events this listener handled.
long	getTotalTime()	Gets the total time calls to this listener have taken
boolean	hasMultiple()	Gets whether this listener has handled multiple events, such that for some two events, eventA.getClass() != eventB.getClass().
void	reset()	Resets the call count and total time for this listener

Methods inherited from class RegisteredListener

getExecutor, getListener, getPlugin, getPriority, isIgnoringCancelled, toString

Methods inherited from class Object

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

Constructor Details

TimedRegisteredListener

public TimedRegisteredListener(@NotNull
 @NotNull Listener pluginListener,
 @NotNull
 @NotNull EventExecutor eventExecutor,
 @NotNull
 @NotNull EventPriority eventPriority,
 @NotNull
 @NotNull Plugin registeredPlugin,
 boolean listenCancelled)

Since:

1.1.0

Method Details

callEvent

public void callEvent(@NotNull
 @NotNull Event event)
               throws EventException

Description copied from class: RegisteredListener

Calls the event executor

Overrides:

callEvent in class RegisteredListener

Parameters:

event - The event

Throws:

EventException - If an event handler throws an exception.

Since:

1.1.0

reset

public void reset()

Resets the call count and total time for this listener

Since:

1.1.0

getCount

public int getCount()

Gets the total times this listener has been called

Returns:

Times this listener has been called

Since:

1.1.0

getTotalTime

public long getTotalTime()

Gets the total time calls to this listener have taken

Returns:

Total time for all calls of this listener

Since:

1.1.0

getEventClass

@Nullable
public @Nullable Class<? extends Event> getEventClass()

Gets the class of the events this listener handled. If it handled multiple classes of event, the closest shared superclass will be returned, such that for any event this listener has handled, this.getEventClass().isAssignableFrom(event.getClass()) and no class this.getEventClass().isAssignableFrom(clazz) && this.getEventClass() != clazz && event.getClass().isAssignableFrom(clazz) for all handled events.

Returns:

the event class handled by this RegisteredListener

Since:

1.6.2

hasMultiple

public boolean hasMultiple()

Gets whether this listener has handled multiple events, such that for some two events, eventA.getClass() != eventB.getClass().

Returns:

true if this listener has handled multiple events

Since:

1.1.0