cc.carm.lib.easylistener

类 EasyListener

java.lang.Object

cc.carm.lib.easylistener.EasyListener

所有已实现的接口:

org.bukkit.event.Listener

public class EasyListener
extends java.lang.Object
implements org.bukkit.event.Listener

轻松(做)监听，简单快捷的通用Bukkit插件监听器类库。

作者:

CarmJos

字段概要

字段

限定符和类型	字段和说明
protected org.bukkit.plugin.Plugin	plugin

构造器概要

构造器

构造器和说明
EasyListener(org.bukkit.plugin.Plugin plugin)

方法概要

限定符和类型	方法和说明
<T extends org.bukkit.event.Event> EasyListener	cancel(@NotNull java.lang.Class<T> eventClass) 无判别地取消一个事件。
<T extends org.bukkit.event.Event> EasyListener	cancel(@NotNull java.lang.Class<T> eventClass, @Nullable org.bukkit.event.EventPriority priority, @Nullable java.util.function.Predicate<? super T> eventPredicate) 有条件地取消一个事件。
<T extends org.bukkit.event.Event> EasyListener	cancel(@NotNull java.lang.Class<T> eventClass, @Nullable org.bukkit.event.EventPriority priority, @Nullable java.util.function.Predicate<? super T> eventPredicate, @Nullable java.util.function.Consumer<? super T> afterCancelled) 有条件地取消一个事件。
<T extends org.bukkit.event.Event> EasyListener	cancel(@NotNull java.lang.Class<T> eventClass, @Nullable java.util.function.Predicate<T> eventPredicate) 有条件地取消一个事件。
static @NotNull EasyListener	create(@NotNull org.bukkit.plugin.Plugin plugin) 创建一个新的 EasyListener 实例
protected <T extends org.bukkit.event.Event> org.bukkit.plugin.EventExecutor	createExecutor(@NotNull java.lang.Class<T> eventClass, @NotNull java.util.function.Consumer<T> eventConsumer) 创建一个事件的执行器实例。
org.bukkit.plugin.Plugin	getPlugin()
<T extends org.bukkit.event.Event> EasyListener	handle(@NotNull java.lang.Class<T> eventClass, boolean ignoreCancelled, @NotNull java.util.function.Consumer<T> eventConsumer) 处理一个事件。
<T extends org.bukkit.event.Event> EasyListener	handle(@NotNull java.lang.Class<T> eventClass, @NotNull java.util.function.Consumer<T> eventConsumer) 处理一个事件。
<T extends org.bukkit.event.Event> EasyListener	handle(@NotNull java.lang.Class<T> eventClass, @Nullable org.bukkit.event.EventPriority priority, boolean ignoreCancelled, @NotNull java.util.function.Consumer<T> eventConsumer) 处理一个事件。
<T extends org.bukkit.event.Event> EasyListener	handle(@NotNull java.lang.Class<T> eventClass, @Nullable org.bukkit.event.EventPriority priority, @NotNull java.util.function.Consumer<T> eventConsumer) 处理一个事件。
<T> @NotNull BundleEventHandler<T,org.bukkit.event.Event>	handleBundle(@NotNull java.lang.Class<T> elementClass) 利用 functional 接口对多个同属 Event 进行监听处理。
<T,E extends org.bukkit.event.Event> @NotNull BundleEventHandler<T,E>	handleBundle(@NotNull java.lang.Class<T> elementClass, @NotNull java.lang.Class<E> eventType) 利用 functional 接口对多个同属 Event 进行监听处理。
<E extends org.bukkit.event.Event> @NotNull SingleEventHandler<E>	handleEvent(@NotNull java.lang.Class<E> eventClass) 利用 functional 接口对单个 Event 进行监听处理。
<E extends org.bukkit.event.Event> @NotNull MultiEventHandler<E>	handleEvents(@NotNull java.lang.Class<E> eventType) 利用 functional 接口对多个同类 Event 进行监听处理。
protected void	register(@NotNull java.lang.Class<? extends org.bukkit.event.Event> eventClass, @NotNull org.bukkit.plugin.EventExecutor executor, @NotNull org.bukkit.event.EventPriority priority, boolean ignoreCancelled)
protected void	register(@NotNull java.lang.Class<? extends org.bukkit.event.Event> eventClass, @NotNull org.bukkit.plugin.RegisteredListener listener)
protected <T extends org.bukkit.event.Event> void	register(@NotNull java.lang.Class<T> eventClass, @NotNull java.util.function.Consumer<T> eventConsumer, @NotNull org.bukkit.event.EventPriority priority, boolean ignoreCancelled)
void	unregisterAll() 注销本监听器内的全部监听器。

从类继承的方法 java.lang.Object

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

字段详细资料

plugin

protected final org.bukkit.plugin.Plugin plugin

构造器详细资料

EasyListener

public EasyListener(org.bukkit.plugin.Plugin plugin)

方法详细资料

create

@NotNull
public static @NotNull EasyListener create(@NotNull
                                                    @NotNull org.bukkit.plugin.Plugin plugin)

创建一个新的 EasyListener 实例

参数:

plugin - Plugin插件实例

返回:

EasyListener 实例

unregisterAll

public void unregisterAll()

注销本监听器内的全部监听器。
也可以通过 HandlerList.unregister(Listener) 方法注销本监听器。

handleEvent

@NotNull
public <E extends org.bukkit.event.Event> @NotNull SingleEventHandler<E> handleEvent(@NotNull
                                                                                              @NotNull java.lang.Class<E> eventClass)

利用 functional 接口对单个 Event 进行监听处理。

类型参数:

E - Event 事件的类型

参数:

eventClass - Event 事件类

返回:

SingleEventHandler 构造器实例

handleEvents

@NotNull
public <E extends org.bukkit.event.Event> @NotNull MultiEventHandler<E> handleEvents(@NotNull
                                                                                              @NotNull java.lang.Class<E> eventType)

利用 functional 接口对多个同类 Event 进行监听处理。
创建后，通过MultiEventHandler.from(Class) 申明具体监听的事件类型。

类型参数:

E - Event 的类型

参数:

eventType - Event 的主要类型，如 PlayerEvent、BlockEvent 等。

返回:

MultiEventHandler 构造器实例

handleBundle

@NotNull
public <T> @NotNull BundleEventHandler<T,org.bukkit.event.Event> handleBundle(@NotNull
                                                                                       @NotNull java.lang.Class<T> elementClass)

利用 functional 接口对多个同属 Event 进行监听处理。
创建后，通过BundleEventHandler.from(Class, Function) 申明具体监听的事件类型与转换函数。
通过转换函数，即可以将 Event 转换为给定类型实例，以方便统一处理。

类型参数:

T - 要处理的目标类型

参数:

elementClass - 要处理的目标类型类，如 Player、Block 等。

返回:

BundleEventHandler 构造器实例

handleBundle

@NotNull
public <T,E extends org.bukkit.event.Event> @NotNull BundleEventHandler<T,E> handleBundle(@NotNull
                                                                                                   @NotNull java.lang.Class<T> elementClass,
                                                                                                   @NotNull
                                                                                                   @NotNull java.lang.Class<E> eventType)

利用 functional 接口对多个同属 Event 进行监听处理。
创建后，通过BundleEventHandler.from(Class, Function) 申明具体监听的事件类型与转换函数。
通过转换函数，即可以将 Event 转换为给定类型实例，以方便统一处理。

类型参数:

T - 要处理的目标类型

参数:

elementClass - 要处理的目标类型类，如 Player、Block 等。

eventType - Event 的主要类型，如 PlayerEvent、BlockEvent 等。

返回:

BundleEventHandler 构造器实例

handle

public <T extends org.bukkit.event.Event> EasyListener handle(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass,
                                                              @Nullable
                                                              @Nullable org.bukkit.event.EventPriority priority,
                                                              boolean ignoreCancelled,
                                                              @NotNull
                                                              @NotNull java.util.function.Consumer<T> eventConsumer)

处理一个事件。

类型参数:

T - Event 事件的类型

参数:

eventClass - Event 事件类

priority - EventPriority 事件处理优先级

ignoreCancelled - 是否忽略掉已经被取消的事件

eventConsumer - 处理方法

返回:

本实例

cancel

public <T extends org.bukkit.event.Event> EasyListener cancel(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass,
                                                              @Nullable
                                                              @Nullable org.bukkit.event.EventPriority priority,
                                                              @Nullable
                                                              @Nullable java.util.function.Predicate<? super T> eventPredicate,
                                                              @Nullable
                                                              @Nullable java.util.function.Consumer<? super T> afterCancelled)

有条件地取消一个事件。
本方法在条件满足时对事件进行取消，不会改变事件取消的状态。
因此，已经被取消的事件将不再进行判断和取消。。

类型参数:

T - Event 事件的类型，必须实现 Cancellable 。

参数:

eventClass - Event 事件类

priority - EventPriority 事件处理优先级

eventPredicate - 判断事件是否可以取消的条件

afterCancelled - 当事件被取消后执行的方法

返回:

本实例

抛出:

java.lang.IllegalArgumentException - 如果事件没有实现 Cancellable 则抛出此异常

cancel

public <T extends org.bukkit.event.Event> EasyListener cancel(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass,
                                                              @Nullable
                                                              @Nullable org.bukkit.event.EventPriority priority,
                                                              @Nullable
                                                              @Nullable java.util.function.Predicate<? super T> eventPredicate)

有条件地取消一个事件。
本方法在条件满足时对事件进行取消，不会改变事件取消的状态。
因此，已经被取消的事件将不再进行判断和取消。。

类型参数:

T - Event 事件的类型，必须实现 Cancellable 。

参数:

eventClass - Event 事件类

priority - EventPriority 事件处理优先级

eventPredicate - 判断事件是否可以取消的条件

返回:

本实例

抛出:

java.lang.IllegalArgumentException - 如果事件没有实现 Cancellable 则抛出此异常

handle

public <T extends org.bukkit.event.Event> EasyListener handle(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass,
                                                              @NotNull
                                                              @NotNull java.util.function.Consumer<T> eventConsumer)

处理一个事件。

类型参数:

T - Event 事件的类型

参数:

eventClass - Event 事件类

eventConsumer - 处理方法

返回:

本实例

handle

public <T extends org.bukkit.event.Event> EasyListener handle(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass,
                                                              boolean ignoreCancelled,
                                                              @NotNull
                                                              @NotNull java.util.function.Consumer<T> eventConsumer)

处理一个事件。

类型参数:

T - Event 事件的类型

参数:

eventClass - Event 事件类

ignoreCancelled - 是否忽略掉已经被取消的事件

eventConsumer - 处理方法

返回:

本实例

handle

public <T extends org.bukkit.event.Event> EasyListener handle(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass,
                                                              @Nullable
                                                              @Nullable org.bukkit.event.EventPriority priority,
                                                              @NotNull
                                                              @NotNull java.util.function.Consumer<T> eventConsumer)

处理一个事件。

类型参数:

T - Event 事件的类型

参数:

eventClass - Event 事件类

priority - EventPriority 事件处理优先级

eventConsumer - 处理方法

返回:

本实例

cancel

public <T extends org.bukkit.event.Event> EasyListener cancel(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass)

无判别地取消一个事件。

类型参数:

T - Event 事件的类型，必须实现 Cancellable 。

参数:

eventClass - Event 事件类

返回:

本实例

抛出:

java.lang.IllegalArgumentException - 如果事件没有实现 Cancellable 则抛出此异常

cancel

public <T extends org.bukkit.event.Event> EasyListener cancel(@NotNull
                                                              @NotNull java.lang.Class<T> eventClass,
                                                              @Nullable
                                                              @Nullable java.util.function.Predicate<T> eventPredicate)

有条件地取消一个事件。

类型参数:

T - Event 事件的类型，必须实现 Cancellable 。

参数:

eventClass - Event 事件类

eventPredicate - 判断事件是否可以取消的条件

返回:

本实例

抛出:

java.lang.IllegalArgumentException - 如果事件没有实现 Cancellable 则抛出此异常

getPlugin

public org.bukkit.plugin.Plugin getPlugin()

createExecutor

protected <T extends org.bukkit.event.Event> org.bukkit.plugin.EventExecutor createExecutor(@NotNull
                                                                                            @NotNull java.lang.Class<T> eventClass,
                                                                                            @NotNull
                                                                                            @NotNull java.util.function.Consumer<T> eventConsumer)

创建一个事件的执行器实例。

类型参数:

T - 事件类型

参数:

eventClass - 事件类

eventConsumer - 事件执行内容

返回:

事件的执行器实例

register

protected void register(@NotNull
                        @NotNull java.lang.Class<? extends org.bukkit.event.Event> eventClass,
                        @NotNull
                        @NotNull org.bukkit.plugin.RegisteredListener listener)

register

protected void register(@NotNull
                        @NotNull java.lang.Class<? extends org.bukkit.event.Event> eventClass,
                        @NotNull
                        @NotNull org.bukkit.plugin.EventExecutor executor,
                        @NotNull
                        @NotNull org.bukkit.event.EventPriority priority,
                        boolean ignoreCancelled)

register

protected <T extends org.bukkit.event.Event> void register(@NotNull
                                                           @NotNull java.lang.Class<T> eventClass,
                                                           @NotNull
                                                           @NotNull java.util.function.Consumer<T> eventConsumer,
                                                           @NotNull
                                                           @NotNull org.bukkit.event.EventPriority priority,
                                                           boolean ignoreCancelled)