com.fr.module

枚举 ModuleRole

java.lang.Object

java.lang.Enum<ModuleRole>

com.fr.module.ModuleRole

所有已实现的接口:

EventEntry, Module, ModuleSelector, ModuleStableRepository, ModuleStableRepositoryAccessor, Lifecycle, java.io.Serializable, java.lang.Comparable<ModuleRole>

public enum ModuleRole
extends java.lang.Enum<ModuleRole>
implements Module

Created by juhaoyu on 2018/6/5. 模块树中的角色，一个萝卜一个坑，用于快捷访问

枚举常量概要

枚举常量

枚举常量和说明
Root 根
ServerRoot 服务器应用模块的root
WorkspaceProvider 环境提供者

方法概要

方法

限定符和类型	方法和说明
<T> void	addMutable(StableKey<T> key, T... mutable) 添加mutable
void	clearMutable(StableKey key) 清除当前模块中注册的mutable
Module	findAncestor(java.lang.Class<? extends Activator> clazz) 查找上级
Module	findDescendant(java.lang.Class<? extends Activator> clazz) 查找下级
java.lang.String	getAttribute(ModuleAttribute attribute) 获取模块扩展属性（不包含name、activator和ref）
<T> java.util.List<T>	getMutable(StableKey<T> key) 获取当前注册进来的Mutable
java.lang.String	getName() 模块名
Module	getParent() 父模块
java.lang.Class<? extends Activator>	getRelevantActivator() 获取相关联的Activator类，用作模块的ID
Module	getRoot() 根模块
<T> T	getSingleton(java.lang.Class<T> clazz) 获取实现了某个接口的单例
Module	getSub(java.lang.Class<? extends Activator> clazz) 根据Activator的class对象获取子Module
Module	getSub(java.lang.String name) 获取子模块
ModuleGroup	getSubRepo() 获取子模块仓库
java.lang.String	getTag()
boolean	isAbsent() 缺席
boolean	isNotAbsent() 是否就位
boolean	isRunning() 状态判断
<T> T	leftFindSingleton(java.lang.Class<T> clazz) 向左查找singleton
<T> void	listenEvent(Event<T>[] events, Listener<T> listener) 监听一大堆事件
<T> void	listenEvent(Event<T> eventType, Listener<T> listener) 监听某事件
<T> void	listenEvent(Event<T> eventType, Listener<T> listener, Filter<T> filter) 包含事件过滤器
java.util.List<Module>	listSubs() 以配置的顺序获取子模块
Lifecycle	once(LifecycleEvent event, LifecycleListener listener) 添加监听
<T> void	registerMutable(StableKey<T> key, StableKeyExecutor<T> executor) 向右（所有比当前模块后启动的模块）收集对象，用于实现上层向下层的注册 收集到的List顺序是注册的顺序 同时接收插件提供的StableKey
<T> T	removeSingleton(java.lang.Class<T> clazz) 删除singleton
<T> java.util.List<T>	rightCollectMutable(StableKey<T> key) 向右（所有比当前模块后启动的模块）收集对象，用于实现上层向下层的注册 收集到的List顺序是注册的顺序
void	set(Module module)
<T> void	setSingleton(java.lang.Class<T> clazz, T singleton) 注册一个单例到Context中，通常是一个实现了某接口的单例，用于桥接一个模块的接口部分和实现部分 如已经存在了该类型的单例，会抛RuntimeException
void	start() 启动
void	stop() 关闭
<T> T	upFindSingleton(java.lang.Class<T> clazz) 向上查找singleton，即当前模块不存在的话，会请求parent的findSingleton方法，直到root 这种模式可以用来让子模块覆盖上层模块的某些实现（overwrite） 用于模块的父子关系中，更具体（也就是更小的模块）可以覆盖所在大模块的某种实现，从而实现在局部范围内的特殊性 上下关系是父子关系
static ModuleRole	valueOf(java.lang.String name) 返回带有指定名称的该类型的枚举常量。
static ModuleRole[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

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

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

Root

public static final ModuleRole Root

根

WorkspaceProvider

public static final ModuleRole WorkspaceProvider

环境提供者

ServerRoot

public static final ModuleRole ServerRoot

服务器应用模块的root

方法详细资料

values

public static ModuleRole[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (ModuleRole c : ModuleRole.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static ModuleRole valueOf(java.lang.String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

java.lang.IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

java.lang.NullPointerException - 如果参数为空值

set

public void set(Module module)

getName

public java.lang.String getName()

从接口复制的说明: Module

模块名

指定者:

getName 在接口中 Module

getRelevantActivator

public java.lang.Class<? extends Activator> getRelevantActivator()

从接口复制的说明: Module

获取相关联的Activator类，用作模块的ID

指定者:

getRelevantActivator 在接口中 Module

getAttribute

public java.lang.String getAttribute(ModuleAttribute attribute)

从接口复制的说明: Module

获取模块扩展属性（不包含name、activator和ref）

指定者:

getAttribute 在接口中 Module

listenEvent

public <T> void listenEvent(Event<T>[] events,
                   Listener<T> listener)

从接口复制的说明: EventEntry

监听一大堆事件

指定者:

listenEvent 在接口中 EventEntry

listenEvent

public <T> void listenEvent(Event<T> eventType,
                   Listener<T> listener)

从接口复制的说明: EventEntry

监听某事件

指定者:

listenEvent 在接口中 EventEntry

listenEvent

public <T> void listenEvent(Event<T> eventType,
                   Listener<T> listener,
                   Filter<T> filter)

从接口复制的说明: EventEntry

包含事件过滤器

指定者:

listenEvent 在接口中 EventEntry

getParent

public Module getParent()

从接口复制的说明: ModuleSelector

父模块

指定者:

getParent 在接口中 ModuleSelector

getRoot

public Module getRoot()

从接口复制的说明: ModuleSelector

根模块

指定者:

getRoot 在接口中 ModuleSelector

findAncestor

public Module findAncestor(java.lang.Class<? extends Activator> clazz)

从接口复制的说明: ModuleSelector

查找上级

指定者:

findAncestor 在接口中 ModuleSelector

findDescendant

public Module findDescendant(java.lang.Class<? extends Activator> clazz)

从接口复制的说明: ModuleSelector

查找下级

指定者:

findDescendant 在接口中 ModuleSelector

getSub

public Module getSub(java.lang.String name)

从接口复制的说明: ModuleSelector

获取子模块

指定者:

getSub 在接口中 ModuleSelector

getSub

public Module getSub(java.lang.Class<? extends Activator> clazz)

从接口复制的说明: ModuleSelector

根据Activator的class对象获取子Module

指定者:

getSub 在接口中 ModuleSelector

listSubs

public java.util.List<Module> listSubs()

从接口复制的说明: ModuleSelector

以配置的顺序获取子模块

指定者:

listSubs 在接口中 ModuleSelector

getSubRepo

public ModuleGroup getSubRepo()

从接口复制的说明: ModuleSelector

获取子模块仓库

指定者:

getSubRepo 在接口中 ModuleSelector

setSingleton

public <T> void setSingleton(java.lang.Class<T> clazz,
                    T singleton)

从接口复制的说明: ModuleStableRepository

注册一个单例到Context中，通常是一个实现了某接口的单例，用于桥接一个模块的接口部分和实现部分 如已经存在了该类型的单例，会抛RuntimeException

指定者:

setSingleton 在接口中 ModuleStableRepository

getSingleton

public <T> T getSingleton(java.lang.Class<T> clazz)

从接口复制的说明: ModuleStableRepository

获取实现了某个接口的单例

指定者:

getSingleton 在接口中 ModuleStableRepository

removeSingleton

public <T> T removeSingleton(java.lang.Class<T> clazz)

从接口复制的说明: ModuleStableRepository

删除singleton

指定者:

removeSingleton 在接口中 ModuleStableRepository

addMutable

public <T> void addMutable(StableKey<T> key,
                  T... mutable)

从接口复制的说明: ModuleStableRepository

添加mutable

指定者:

addMutable 在接口中 ModuleStableRepository

getMutable

public <T> java.util.List<T> getMutable(StableKey<T> key)

从接口复制的说明: ModuleStableRepository

获取当前注册进来的Mutable

指定者:

getMutable 在接口中 ModuleStableRepository

clearMutable

public void clearMutable(StableKey key)

从接口复制的说明: ModuleStableRepository

清除当前模块中注册的mutable

指定者:

clearMutable 在接口中 ModuleStableRepository

upFindSingleton

public <T> T upFindSingleton(java.lang.Class<T> clazz)

从接口复制的说明: ModuleStableRepositoryAccessor

向上查找singleton，即当前模块不存在的话，会请求parent的findSingleton方法，直到root 这种模式可以用来让子模块覆盖上层模块的某些实现（overwrite） 用于模块的父子关系中，更具体（也就是更小的模块）可以覆盖所在大模块的某种实现，从而实现在局部范围内的特殊性 上下关系是父子关系

指定者:

upFindSingleton 在接口中 ModuleStableRepositoryAccessor

leftFindSingleton

public <T> T leftFindSingleton(java.lang.Class<T> clazz)

从接口复制的说明: ModuleStableRepositoryAccessor

向左查找singleton

指定者:

leftFindSingleton 在接口中 ModuleStableRepositoryAccessor

rightCollectMutable

public <T> java.util.List<T> rightCollectMutable(StableKey<T> key)

从接口复制的说明: ModuleStableRepositoryAccessor

向右（所有比当前模块后启动的模块）收集对象，用于实现上层向下层的注册 收集到的List顺序是注册的顺序

指定者:

rightCollectMutable 在接口中 ModuleStableRepositoryAccessor

registerMutable

public <T> void registerMutable(StableKey<T> key,
                       StableKeyExecutor<T> executor)

从接口复制的说明: ModuleStableRepositoryAccessor

向右（所有比当前模块后启动的模块）收集对象，用于实现上层向下层的注册 收集到的List顺序是注册的顺序 同时接收插件提供的StableKey

指定者:

registerMutable 在接口中 ModuleStableRepositoryAccessor

start

public void start()

从接口复制的说明: Lifecycle

启动

指定者:

start 在接口中 Lifecycle

stop

public void stop()

从接口复制的说明: Lifecycle

关闭

指定者:

stop 在接口中 Lifecycle

isRunning

public boolean isRunning()

从接口复制的说明: Lifecycle

状态判断

指定者:

isRunning 在接口中 Lifecycle

once

public Lifecycle once(LifecycleEvent event,
             LifecycleListener listener)

从接口复制的说明: Lifecycle

添加监听

指定者:

once 在接口中 Lifecycle

getTag

public java.lang.String getTag()

isNotAbsent

public boolean isNotAbsent()

是否就位

isAbsent

public boolean isAbsent()

缺席