pro.fessional.mirana.cast

Interface BiConvertor<S,T>

All Known Implementing Classes:

EnumConvertor, MethodConvertor

public interface BiConvertor<S,T>

Bi-direction conversion of Source and Target, `-or` suffix to diff from the main framework

Since:

2021-01-17

Author:

trydofor

Method Summary

Modifier and Type	Method and Description
default boolean	canToSource(Class<?> source, Object target) Whether the target can be converted to the specified source type
default boolean	canToSource(Object target) Whether the target can be converted to the source
default boolean	canToTarget(Class<?> target, Object source) Whether the source can be converted to the specified target type
default boolean	canToTarget(Object source) Whether the source can be converted to the target
default <R> BiConvertor<S,R>	compose(BiConvertor<T,R> that) Combine S2T and T2R to S2R convertor
static <A,B> BiConvertor<A,B>	of(Class<A> ca, Class<B> cb, Function<? super A,? extends B> a2b, Function<? super B,? extends A> b2a) Tool to construct a A2B anonymous convertor
default BiConvertor<T,S>	reverseBiConvertor() reverse the source and target
@NotNull Class<S>	sourceType() the source type
@NotNull Class<T>	targetType() the target type
S	toSource(T target) convert target to source
T	toTarget(S source) convert source to target
default S	tryToSource(Class<?> source, Object target) Try to convert any target to source, first check `canToSource`, then try, return null if it can't
default S	tryToSource(Object target) Try to convert any target to source, first check `canToSource`, then try, return null if it can't
default T	tryToTarget(Class<?> target, Object source) Try to convert any source to target, first check `canToTarget`, then try, return null if it can't
default T	tryToTarget(Object source) Try to convert any source to target, first check `canToTarget`, then try, return null if it can't

Method Detail

sourceType

@NotNull
@NotNull Class<S> sourceType()

the source type

targetType

@NotNull
@NotNull Class<T> targetType()

the target type

toTarget

@Nullable
 @Contract(value="null->null;!null->!null")
T toTarget(S source)

convert source to target

Parameters:

source - the source

Returns:

the target

Throws:

IllegalFormatConversionException - if unsupported

toSource

@Nullable
 @Contract(value="null->null;!null->!null")
S toSource(T target)

convert target to source

Parameters:

target - the target

Returns:

the source

Throws:

IllegalFormatConversionException - if unsupported

tryToTarget

@Nullable
default T tryToTarget(Object source)

Try to convert any source to target, first check `canToTarget`, then try, return null if it can't

Parameters:

source - any type of source

Returns:

null or target

tryToSource

@Nullable
default S tryToSource(Object target)

Try to convert any target to source, first check `canToSource`, then try, return null if it can't

Parameters:

target - any type of target

Returns:

null or source

tryToTarget

@Nullable
default T tryToTarget(Class<?> target,
                                Object source)

Try to convert any source to target, first check `canToTarget`, then try, return null if it can't

Parameters:

target - target type

source - any source

Returns:

null or target

tryToSource

@Nullable
default S tryToSource(Class<?> source,
                                Object target)

Try to convert any target to source, first check `canToSource`, then try, return null if it can't

Parameters:

source - source type

target - any target

Returns:

null or source

canToSource

default boolean canToSource(Class<?> source,
                            Object target)

Whether the target can be converted to the specified source type

Parameters:

source - the source type

target - target

canToTarget

default boolean canToTarget(Class<?> target,
                            Object source)

Whether the source can be converted to the specified target type

Parameters:

target - the target type

source - source

canToSource

default boolean canToSource(Object target)

Whether the target can be converted to the source

canToTarget

default boolean canToTarget(Object source)

Whether the source can be converted to the target

reverseBiConvertor

default BiConvertor<T,S> reverseBiConvertor()

reverse the source and target

compose

default <R> BiConvertor<S,R> compose(BiConvertor<T,R> that)

Combine S2T and T2R to S2R convertor

Type Parameters:

R - return type

Parameters:

that - T2R convertor

Returns:

S2R convertor

of

static <A,B> BiConvertor<A,B> of(Class<A> ca,
                                 Class<B> cb,
                                 Function<? super A,? extends B> a2b,
                                 Function<? super B,? extends A> b2a)

Tool to construct a A2B anonymous convertor

Type Parameters:

A - A

B - B

Parameters:

ca - class A

cb - class B

a2b - a2b lambda

b2a - b2a lambda

Returns:

convertor