程序包 org.babyfish.jimmer.sql.runtime

接口 ScalarProvider<T,S>

所有已知实现类:

AbstractScalarProvider

public interface ScalarProvider<T,S>

嵌套类概要

嵌套类

修饰符和类型	接口	说明
static class	ScalarProvider.Meta

方法概要

修饰符和类型	方法	说明
static <E extends Enum<E>> ScalarProvider<E,Integer>	enumProviderByInt(Class<E> enumType)
static <E extends Enum<E>> ScalarProvider<E,Integer>	enumProviderByInt(Class<E> enumType, Consumer<EnumProviderBuilder<E,Integer>> block)
static <E extends Enum<E>> ScalarProvider<E,String>	enumProviderByString(Class<E> enumType)
static <E extends Enum<E>> ScalarProvider<E,String>	enumProviderByString(Class<E> enumType, Consumer<EnumProviderBuilder<E,String>> block)
default Collection<org.babyfish.jimmer.meta.ImmutableProp>	getHandledProps()	User can override this method, it can return null, empty or handled property.
default @NotNull Type	getScalarType()
default @NotNull Class<S>	getSqlType()
default boolean	isJsonScalar()
default Reader<S>	reader()
T	toScalar(S sqlValue)
S	toSql(T scalarValue)
static ScalarProvider<UUID,byte[]>	uuidByByteArray()
static ScalarProvider<UUID,String>	uuidByString()

方法详细资料

getScalarType

@NotNull
default @NotNull Type getScalarType()

getSqlType

@NotNull
default @NotNull Class<S> getSqlType()

toScalar

T toScalar(@NotNull
 S sqlValue)
    throws Exception

抛出:

Exception

toSql

S toSql(@NotNull
 T scalarValue)
 throws Exception

抛出:

Exception

getHandledProps

default Collection<org.babyfish.jimmer.meta.ImmutableProp> getHandledProps()

User can override this method, it can return null, empty or handled property.

• Null or empty: Global scalar provider, can be applied to any properties
• Otherwise: Property-specific scalar provider

Actually, there are two ways to add property-specific scalar providers

• Override getHandledProps()
• Use JSqlClient.Builder.setScalarProvider(ImmutableProp, ScalarProvider) or JSqlClient.Builder.setScalarProvider(TypedProp, ScalarProvider)

返回:

Null or handled property.

isJsonScalar

default boolean isJsonScalar()

reader

default Reader<S> reader()

enumProviderByString

static <E extends Enum<E>> ScalarProvider<E,String> enumProviderByString(Class<E> enumType)

enumProviderByString

static <E extends Enum<E>> ScalarProvider<E,String> enumProviderByString(Class<E> enumType,
 Consumer<EnumProviderBuilder<E,String>> block)

enumProviderByInt

static <E extends Enum<E>>
ScalarProvider<E,Integer> enumProviderByInt(Class<E> enumType)

enumProviderByInt

static <E extends Enum<E>>
ScalarProvider<E,Integer> enumProviderByInt(Class<E> enumType,
 Consumer<EnumProviderBuilder<E,Integer>> block)

uuidByByteArray

static ScalarProvider<UUID,byte[]> uuidByByteArray()

uuidByString

static ScalarProvider<UUID,String> uuidByString()