agi.foundation.infrastructure

(agi.foundation.core-2024r3.jar)

Class TryFormatConversionCallback<T,TFormatType>

java.lang.Object

agi.foundation.compatibility.Delegate

agi.foundation.infrastructure.TryFormatConversionCallback<T,TFormatType>

Type Parameters:

T - The type of object that this delegate converts the format of.

TFormatType - The class of the format object itself. This can be a base class.

public abstract class TryFormatConversionCallback<T,TFormatType>
extends Delegate

A delegate to try converting a T from one format to another.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TryFormatConversionCallback.Function<T,TFormatType> A functional interface for the containing delegate type.

Constructor Summary

Constructors

Constructor and Description
TryFormatConversionCallback() Creates a new instance of this delegate.
TryFormatConversionCallback(Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Initializes a delegate that will invoke a static method on a class.
TryFormatConversionCallback(Object targetObject, String methodName, Class<?>... methodParameterClasses) Initializes a delegate that will invoke an instance method on a class instance.

Method Summary

Modifier and Type	Method and Description
abstract boolean	invoke(T from, TFormatType targetFormat, T[] result) A delegate to try converting a T from one format to another.
static <T,TFormatType> TryFormatConversionCallback<T,TFormatType>	of(TryFormatConversionCallback.Function<T,TFormatType> f) Create a delegate for the given interface.
static <T,TFormatType> TryFormatConversionCallback<T,TFormatType>	of(TryFormatConversionCallback.Function<T,TFormatType> f, Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Create a delegate for the given interface.
static <T,TFormatType> TryFormatConversionCallback<T,TFormatType>	of(TryFormatConversionCallback.Function<T,TFormatType> f, Object targetObject, String methodName, Class<?>... methodParameterClasses) Create a delegate for the given interface.

Methods inherited from class agi.foundation.compatibility.Delegate

dynamicInvoke, equals, getMethod, getTarget, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

TryFormatConversionCallback

public TryFormatConversionCallback()

Creates a new instance of this delegate.

TryFormatConversionCallback

public TryFormatConversionCallback(@Nonnull
                                   Object targetObject,
                                   @Nonnull
                                   String methodName,
                                   @Nonnull
                                   Class<?>... methodParameterClasses)

Initializes a delegate that will invoke an instance method on a class instance.

Parameters:

targetObject - The class instance on which the delegate will invoke the method.

methodName - The name of the instance method.

methodParameterClasses - The type of the parameters of the instance method.

TryFormatConversionCallback

public TryFormatConversionCallback(@Nonnull
                                   Class<?> targetClass,
                                   @Nonnull
                                   String methodName,
                                   @Nonnull
                                   Class<?>... methodParameterClasses)

Initializes a delegate that will invoke a static method on a class.

Parameters:

targetClass - The class that defines the method.

methodName - The name of the static method.

methodParameterClasses - The type of the parameters of the static method.

Method Detail

invoke

public abstract boolean invoke(T from,
                               TFormatType targetFormat,
                               @Nonnull
                               T[] result)

A delegate to try converting a T from one format to another.

Parameters:

from - The instance of T to convert.

targetFormat - The TFormatType to convert to.

result - On input, an array with one element. On return, the array is populated with the resulting instance of T equivalent to from, in the new TFormatType targetFormat.

Returns:

true if from could be converted to the requested TFormatType targetFormat; otherwise false.

of

@Nonnull
public static <T,TFormatType> TryFormatConversionCallback<T,TFormatType> of(@Nonnull
                                                                                      TryFormatConversionCallback.Function<T,TFormatType> f)

Create a delegate for the given interface. This can be used to create a delegate from a lambda expression.

Parameters:

f - The function which will be invoked.

Returns:

A new delegate that will invoke the given function.

of

@Nonnull
public static <T,TFormatType> TryFormatConversionCallback<T,TFormatType> of(@Nonnull
                                                                                      TryFormatConversionCallback.Function<T,TFormatType> f,
                                                                                      @Nonnull
                                                                                      Object targetObject,
                                                                                      @Nonnull
                                                                                      String methodName,
                                                                                      @Nonnull
                                                                                      Class<?>... methodParameterClasses)

Create a delegate for the given interface. This can be used to create a delegate from a method reference to an instance method.

Parameters:

f - The function which will be invoked.

targetObject - The class instance on which the delegate will invoke the method.

methodName - The name of the instance method.

methodParameterClasses - The type of the parameters of the instance method.

Returns:

A new delegate that will invoke the given function.

of

@Nonnull
public static <T,TFormatType> TryFormatConversionCallback<T,TFormatType> of(@Nonnull
                                                                                      TryFormatConversionCallback.Function<T,TFormatType> f,
                                                                                      @Nonnull
                                                                                      Class<?> targetClass,
                                                                                      @Nonnull
                                                                                      String methodName,
                                                                                      @Nonnull
                                                                                      Class<?>... methodParameterClasses)

Create a delegate for the given interface. This can be used to create a delegate from a method reference to a static method.

Parameters:

f - The function which will be invoked.

targetClass - The class that defines the method.

methodName - The name of the static method.

methodParameterClasses - The type of the parameters of the static method.

Returns:

A new delegate that will invoke the given function.