Package com.github.phantomthief.scope

Class ScopeKey<T>

java.lang.Object

com.github.phantomthief.scope.ScopeKey<T>

public final class ScopeKey<T>
extends Object

强类型数据读写的封装

如果多个线程共享了一个Scope，那么他们对于ScopeKey的get/set调用是操作的同一个值，这一点和ThreadLocal不一样，ThreadLocal 每个线程总是访问自己的一份变量。 因而，ScopeKey也不能在所有场合都无脑替换ThreadLocal。 更多信息参考 Scope的文档。

Author:

w.vela

Method Summary

Modifier and Type	Method	Description
static <T> ScopeKey<T>	allocate()
T	get()
boolean	set(T value)
static ScopeKey<Boolean>	withDefaultValue(boolean defaultValue)
static ScopeKey<Double>	withDefaultValue(double defaultValue)
static ScopeKey<Integer>	withDefaultValue(int defaultValue)
static ScopeKey<Long>	withDefaultValue(long defaultValue)
static ScopeKey<String>	withDefaultValue(String defaultValue)
static <T extends Enum<T>> ScopeKey<T>	withDefaultValue(T defaultValue)
static <T> ScopeKey<T>	withInitializer(boolean enableNullProtection, Supplier<T> initializer)
static <T> ScopeKey<T>	withInitializer(Supplier<T> initializer)

Methods inherited from class java.lang.Object

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

Method Details

allocate

@Nonnull
public static <T> ScopeKey<T> allocate()

withDefaultValue

@Nonnull
public static ScopeKey<Boolean> withDefaultValue(boolean defaultValue)

withDefaultValue

@Nonnull
public static ScopeKey<Integer> withDefaultValue(int defaultValue)

withDefaultValue

@Nonnull
public static ScopeKey<Long> withDefaultValue(long defaultValue)

withDefaultValue

@Nonnull
public static ScopeKey<Double> withDefaultValue(double defaultValue)

withDefaultValue

@Nonnull
public static ScopeKey<String> withDefaultValue(String defaultValue)

withDefaultValue

@Nonnull
public static <T extends Enum<T>> ScopeKey<T> withDefaultValue(T defaultValue)

withInitializer

@Nonnull
public static <T> ScopeKey<T> withInitializer(Supplier<T> initializer)

Parameters:

initializer - 初始化ScopeKey（仅在Scope有效时）

等效代码:（调用 get() 时）

 
 T obj = SCOPE_KEY.get();
 if (obj == null) {
     obj = initializer.get();
     SCOPE_KEY.set(obj);
 }
 return obj;
 

注意，如果 initializer 返回 null，每次访问时都会重复初始化执行； 虽然该问题是预期外的，但是考虑到业务如果刚好依赖了此 bug，可能直接修复会产生行为异常，并因此产生不容易发现的意外，所以提供了重载版本修正： 对于可能返回 null 的场景，请使用 withInitializer(boolean, Supplier) 版本，并传递参数 true

withInitializer

@Nonnull
public static <T> ScopeKey<T> withInitializer(boolean enableNullProtection,
 Supplier<T> initializer)

Parameters:

initializer - 初始化ScopeKey（仅在Scope有效时）

等效代码:（调用 get() 时）

 
 T obj = SCOPE_KEY.get();
 if (obj == null) {
     obj = initializer.get();
     SCOPE_KEY.set(obj);
 }
 return obj;
 

get

public T get()

set

public boolean set(T value)

Returns:

true if in a scope and set success.