cn.ideabuffer.process.core.context

类 ContextWrapper

java.lang.Object

cn.ideabuffer.process.core.context.ContextWrapper

所有已实现的接口:

Context, Parameter

public class ContextWrapper
extends Object
implements Context

context包装类，在新创建作用域时，将当前context与新创建的block进行包装，这样可以实现不同作用域的功能。同时还会有参数映射、权限校验的功能。

作者:

sangjian.sj

另请参阅:

Context, Block, KeyMapper

字段概要

字段

限定符和类型	字段和说明
private Block	block 新作用域的block
private Context	context 被包装的context
private @Nullable KeyMapper	mapper 参数映射器
private @Nullable Set<Key<?>>	readableKeys 可读key
private @Nullable Set<Key<?>>	writableKeys 可写key

构造器概要

构造器

构造器和说明
ContextWrapper(@NotNull Context context, @NotNull Block block)
ContextWrapper(@NotNull Context context, @NotNull Block block, @Nullable KeyManager keyManager)
ContextWrapper(@NotNull Context context, @NotNull Block block, @Nullable KeyMapper mapper, @Nullable Set<Key<?>> readableKeys, @Nullable Set<Key<?>> writableKeys)

方法概要

限定符和类型	方法和说明
Context	cloneContext() 克隆流程上下文，新建流程上下文，并复制当前上下文中的参数至新的上下文对象。
boolean	containsKey(@NotNull Key<?> key) 是否有指定映射
private boolean	containsKey(@NotNull Key<?> key, boolean keyCheck, boolean keyMapping)
boolean	containsValue(@NotNull Object value) 返回是否有指定的值。
<V> V	get(@NotNull Key<V> key) 获取指定类型的值。
protected <V> V	get(@NotNull Key<V> key, boolean keyCheck, boolean keyMapping)
<V> V	get(@NotNull Key<V> key, V defaultValue) 获取指定key的值，如果为null，则取默认值。
private <V> V	get(@NotNull Key<V> key, V defaultValue, boolean keyCheck, boolean keyMapping)
Block	getBlock() 获取当前区块
Throwable	getCurrentException() 获取当前异常对象
KeyMapper	getMapper() 获取参数映射器
@NotNull Map<Key<?>,Object>	getParameters() 获取所有的参数Key，返回结果不可修改
boolean	isEmpty() 如果当前map没有映射时，返回true，否则返回false。
<V> V	put(@NotNull Key<V> key, V value) 添加键值映射
private <V> V	put(@NotNull Key<V> key, V value, boolean keyCheck, boolean keyMapping)
void	putAll(@NotNull Map<? extends Key<?>,?> params) 将params中的所有映射添加至当前map。
private void	putAll(@NotNull Map<? extends Key<?>,?> params, boolean keyCheck, boolean keyMapping)
<V> V	putIfAbsent(@NotNull Key<V> key, V value) 如果当前key对应的value不存在，添加映射，否则不添加。
private <V> V	putIfAbsent(@NotNull Key<V> key, V value, boolean keyCheck, boolean keyMapping)
boolean	readableKey(Key<?> key) 当前key是否可读。
<V> V	remove(@NotNull Key<V> key) 删除指定键的映射关系。
private <V> V	remove(Key<V> key, boolean keyCheck, boolean keyMapping)
void	setCurrentException(Throwable t) 设置当前异常对象
int	size() 获取当前参数映射的大小。
boolean	writableKey(Key<?> key) 当前key是否可写。

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

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

字段详细资料

context

private Context context

被包装的context

block

private Block block

新作用域的block

mapper

@Nullable
private @Nullable KeyMapper mapper

参数映射器

readableKeys

@Nullable
private @Nullable Set<Key<?>> readableKeys

可读key

writableKeys

@Nullable
private @Nullable Set<Key<?>> writableKeys

可写key

构造器详细资料

ContextWrapper

public ContextWrapper(@NotNull
                      @NotNull Context context,
                      @NotNull
                      @NotNull Block block)

ContextWrapper

public ContextWrapper(@NotNull
                      @NotNull Context context,
                      @NotNull
                      @NotNull Block block,
                      @Nullable
                      @Nullable KeyManager keyManager)

ContextWrapper

public ContextWrapper(@NotNull
                      @NotNull Context context,
                      @NotNull
                      @NotNull Block block,
                      @Nullable
                      @Nullable KeyMapper mapper,
                      @Nullable
                      @Nullable Set<Key<?>> readableKeys,
                      @Nullable
                      @Nullable Set<Key<?>> writableKeys)

方法详细资料

getBlock

public Block getBlock()

从接口复制的说明: Context

获取当前区块

指定者:

getBlock 在接口中 Context

返回:

当前区块

cloneContext

public Context cloneContext()

从接口复制的说明: Context

克隆流程上下文，新建流程上下文，并复制当前上下文中的参数至新的上下文对象。

指定者:

cloneContext 在接口中 Context

返回:

克隆后的新流程上下文

put

@Nullable
public <V> V put(@NotNull
                           @NotNull Key<V> key,
                           @NotNull
                           V value)

从接口复制的说明: Parameter

添加键值映射

指定者:

put 在接口中 Parameter

类型参数:

V - 值类型

参数:

key - 与指定值关联的键

value - 与指定键关联的值

返回:

上一次当前key对应的value，如果之前没有key对应的value，返回null

另请参阅:

Map.put(Object, Object)

put

@Nullable
private <V> V put(@NotNull
                            @NotNull Key<V> key,
                            V value,
                            boolean keyCheck,
                            boolean keyMapping)

putIfAbsent

@Nullable
public <V> V putIfAbsent(@NotNull
                                   @NotNull Key<V> key,
                                   @NotNull
                                   V value)

从接口复制的说明: Parameter

如果当前key对应的value不存在，添加映射，否则不添加。

指定者:

putIfAbsent 在接口中 Parameter

类型参数:

V - 值类型

参数:

key - 与指定值关联的键

value - 与指定键关联的值

返回:

如果当前key对应的value已经存在，返回存在的value，不会进行添加。如果不存在，添加key和value，返回null

另请参阅:

Map.putIfAbsent(Object, Object)

putIfAbsent

@Nullable
private <V> V putIfAbsent(@NotNull
                                    @NotNull Key<V> key,
                                    @NotNull
                                    V value,
                                    boolean keyCheck,
                                    boolean keyMapping)

get

@Nullable
public <V> V get(@NotNull
                           @NotNull Key<V> key)

从接口复制的说明: Parameter

获取指定类型的值。

指定者:

get 在接口中 Parameter

类型参数:

V - 返回值类型

参数:

key - 与指定值关联的键

返回:

指定类型的值，如果没有映射，返回null

另请参阅:

Map.get(Object)

get

@Nullable
protected <V> V get(@NotNull
                              @NotNull Key<V> key,
                              boolean keyCheck,
                              boolean keyMapping)

get

public <V> V get(@NotNull
                 @NotNull Key<V> key,
                 V defaultValue)

从接口复制的说明: Parameter

获取指定key的值，如果为null，则取默认值。

指定者:

get 在接口中 Parameter

类型参数:

V - 返回值类型

参数:

key - 与指定值关联的键

defaultValue - 与指定键关联的值如果不存在，返回的默认值

返回:

指定类型的值，如果没有映射，返回defaultValue

另请参阅:

Map.getOrDefault(Object, Object)

getParameters

@NotNull
public @NotNull Map<Key<?>,Object> getParameters()

从接口复制的说明: Parameter

获取所有的参数Key，返回结果不可修改

指定者:

getParameters 在接口中 Parameter

返回:

所有参数Key

另请参阅:

Collections.unmodifiableMap(Map), KeyMapper

get

private <V> V get(@NotNull
                  @NotNull Key<V> key,
                  V defaultValue,
                  boolean keyCheck,
                  boolean keyMapping)

size

public int size()

从接口复制的说明: Parameter

获取当前参数映射的大小。

指定者:

size 在接口中 Parameter

返回:

当前参数映射的大小

另请参阅:

Map.size()

isEmpty

public boolean isEmpty()

从接口复制的说明: Parameter

如果当前map没有映射时，返回true，否则返回false。

指定者:

isEmpty 在接口中 Parameter

返回:

如果当前map没有映射时，返回true，否则返回false

另请参阅:

Map.isEmpty()

containsKey

public boolean containsKey(@NotNull
                           @NotNull Key<?> key)

从接口复制的说明: Parameter

是否有指定映射

指定者:

containsKey 在接口中 Parameter

参数:

key - 与指定值关联的键

返回:

如果当前map有key映射时，返回true，否则返回false

另请参阅:

Map.containsKey(Object)

containsKey

private boolean containsKey(@NotNull
                            @NotNull Key<?> key,
                            boolean keyCheck,
                            boolean keyMapping)

containsValue

public boolean containsValue(@NotNull
                             @NotNull Object value)

从接口复制的说明: Parameter

返回是否有指定的值。

指定者:

containsValue 在接口中 Parameter

参数:

value - 与指定值关联的键

返回:

如果当前map有指定的value时，返回true，否则返回false

另请参阅:

Map.containsValue(Object)

remove

@Nullable
public <V> V remove(@NotNull
                              @NotNull Key<V> key)

从接口复制的说明: Parameter

删除指定键的映射关系。

指定者:

remove 在接口中 Parameter

类型参数:

V - 值类型

参数:

key - 与指定值关联的键

返回:

如果存在映射，返回之前key对应的value，否则返回null

另请参阅:

Map.remove(Object)

remove

@Nullable
private <V> V remove(Key<V> key,
                               boolean keyCheck,
                               boolean keyMapping)

putAll

public void putAll(@NotNull
                   @NotNull Map<? extends Key<?>,?> params)

从接口复制的说明: Parameter

将params中的所有映射添加至当前map。

指定者:

putAll 在接口中 Parameter

参数:

params - 参数map

另请参阅:

Map.putAll(Map)

putAll

private void putAll(@NotNull
                    @NotNull Map<? extends Key<?>,?> params,
                    boolean keyCheck,
                    boolean keyMapping)

readableKey

public boolean readableKey(Key<?> key)

从接口复制的说明: Context

当前key是否可读。

指定者:

readableKey 在接口中 Context

参数:

key - 参数key

返回:

当前key可读，返回true，否则返回false

writableKey

public boolean writableKey(Key<?> key)

从接口复制的说明: Context

当前key是否可写。

指定者:

writableKey 在接口中 Context

参数:

key - 参数key

返回:

当前key可写，返回true，否则返回false

getCurrentException

public Throwable getCurrentException()

从接口复制的说明: Context

获取当前异常对象

指定者:

getCurrentException 在接口中 Context

返回:

当前异常对象

setCurrentException

public void setCurrentException(Throwable t)

从接口复制的说明: Context

设置当前异常对象

指定者:

setCurrentException 在接口中 Context

参数:

t - 当前异常对象

getMapper

public KeyMapper getMapper()

从接口复制的说明: Context

获取参数映射器

指定者:

getMapper 在接口中 Context

返回:

参数映射器