Package me.kzheart.klib.scope
Interface Scope
- All Superinterfaces:
me.kzheart.klib.scope.Disposable
public interface Scope
extends me.kzheart.klib.scope.Disposable
持有资源,并按注册顺序的逆序释放资源。
-
Method Summary
Modifier and TypeMethodDescriptiondefault TaskHandledefault <T> AsyncTask<T> 在异步线程执行提供器;结果需通过AsyncTask.thenSync(java.util.function.Consumer<? super T>)回到主线程后才能访问 Bukkit 状态。voidclose()释放作用域及其子作用域。已关闭的作用域再次调用无副作用;但在关闭或重建尚未完成时调用会抛出IllegalStateException,例如在自身释放回调里再次关闭同一作用域。default CommandRegistrationcommand(String name, Consumer<? super CommandSpec> configure) default <T> ConfigDocument<T> voiddispose()等价于close(),使作用域可以作为父作用域的一项Disposable资源被释放。default TaskHandle<T> Optional<T> findCapability(Class<T> type) 自当前作用域向父作用域逐级查找能力,未找到时返回空。<T extends me.kzheart.klib.scope.Disposable>
Tinstall(T resource) booleanisClosed()name()default <E extends org.bukkit.event.Event>
me.kzheart.klib.scope.Disposabledefault <E extends org.bukkit.event.Event>
me.kzheart.klib.scope.Disposableon(Class<E> eventType, org.bukkit.event.EventPriority priority, boolean ignoreCancelled, Consumer<? super E> handler) voidrebuild()逆序释放当前资源,再重新执行创建根作用域时的初始化逻辑。整个过程在生命周期锁内串行执行, 因此重建期间其他线程的注册与查找操作会等待。<T> TregisterCapability(Class<T> type, T capability) 在当前作用域注册一项能力。同一作用域内同一类型只能注册一次,重复注册抛出IllegalStateException;子作用域可以注册同类型能力以遮蔽父作用域的实现。voidremove(me.kzheart.klib.scope.Disposable resource) 分离先前安装的资源,但不释放它,从而避免已终止的资源在长生命周期作用域中累积。 当资源不存在或作用域生命周期正在变化时不执行任何操作。<T> TrequireCapability(Class<T> type) 与findCapability(java.lang.Class<T>)相同的查找规则,但未找到时抛出IllegalStateException。 该异常表示对应模块尚未安装到本作用域或其任一父作用域。default <S,T> CompletableFuture <T> submitSync(CompletionStage<S> source, Function<? super S, ? extends T> action) 等待源阶段后在主线程转换结果;等待与排队均绑定调用时的作用域构建代。 关闭或重建取消返回的结果,但不会取消或回滚外部源阶段的工作。 源阶段失败时不执行 action。取消/失败及后续非 Async 回调不保证在主线程发生。default <T> CompletableFuture<T> submitSync(Supplier<T> action) 提交到主线程并返回结果。关闭或重建会取消尚未完成的结果,不中断已开始的工作。 提交拒绝与业务异常会使结果异常完成;需要 ScopeImpl 支持的作用域。default TaskHandle把任务投递到服务器主线程执行,可从任意线程调用。 用于在异步回调(包括 JDKCompletionStage的回调)中安全访问 Bukkit API。default Executor返回投递到主线程的 Executor。内置后端在关闭后拒绝提交,已排队任务随作用域取消。 Executor 无法终结被取消的 opaque Runnable 所拥有的派生阶段;需要结果终态时 使用 submitSync 或 AsyncTasks,而不是 JDK Async 组合子加本执行器。
-
Method Details
-
name
String name() -
isClosed
boolean isClosed() -
install
<T extends me.kzheart.klib.scope.Disposable> T install(T resource) -
remove
void remove(me.kzheart.klib.scope.Disposable resource) 分离先前安装的资源,但不释放它,从而避免已终止的资源在长生命周期作用域中累积。 当资源不存在或作用域生命周期正在变化时不执行任何操作。 -
scope
-
registerCapability
在当前作用域注册一项能力。同一作用域内同一类型只能注册一次,重复注册抛出IllegalStateException;子作用域可以注册同类型能力以遮蔽父作用域的实现。 -
findCapability
自当前作用域向父作用域逐级查找能力,未找到时返回空。 -
requireCapability
与findCapability(java.lang.Class<T>)相同的查找规则,但未找到时抛出IllegalStateException。 该异常表示对应模块尚未安装到本作用域或其任一父作用域。 -
on
-
on
-
every
-
after
-
async
在异步线程执行提供器;结果需通过AsyncTask.thenSync(java.util.function.Consumer<? super T>)回到主线程后才能访问 Bukkit 状态。 -
sync
把任务投递到服务器主线程执行,可从任意线程调用。 用于在异步回调(包括 JDKCompletionStage的回调)中安全访问 Bukkit API。 -
submitSync
提交到主线程并返回结果。关闭或重建会取消尚未完成的结果,不中断已开始的工作。 提交拒绝与业务异常会使结果异常完成;需要 ScopeImpl 支持的作用域。 -
submitSync
default <S,T> CompletableFuture<T> submitSync(CompletionStage<S> source, Function<? super S, ? extends T> action) 等待源阶段后在主线程转换结果;等待与排队均绑定调用时的作用域构建代。 关闭或重建取消返回的结果,但不会取消或回滚外部源阶段的工作。 源阶段失败时不执行 action。取消/失败及后续非 Async 回调不保证在主线程发生。 -
syncExecutor
返回投递到主线程的 Executor。内置后端在关闭后拒绝提交,已排队任务随作用域取消。 Executor 无法终结被取消的 opaque Runnable 所拥有的派生阶段;需要结果终态时 使用 submitSync 或 AsyncTasks,而不是 JDK Async 组合子加本执行器。 -
command
-
config
-
rebuild
void rebuild()逆序释放当前资源,再重新执行创建根作用域时的初始化逻辑。整个过程在生命周期锁内串行执行, 因此重建期间其他线程的注册与查找操作会等待。 -
dispose
void dispose()等价于close(),使作用域可以作为父作用域的一项Disposable资源被释放。- Specified by:
disposein interfaceme.kzheart.klib.scope.Disposable
-
close
void close()释放作用域及其子作用域。已关闭的作用域再次调用无副作用;但在关闭或重建尚未完成时调用会抛出IllegalStateException,例如在自身释放回调里再次关闭同一作用域。
-