agi.foundation.infrastructure.threading

Class ThreadedCalculation.BodyCallbackWithProgress<TParameter>

java.lang.Object

agi.foundation.compatibility.Delegate

agi.foundation.infrastructure.threading.ThreadedCalculation.BodyCallbackWithProgress<TParameter>

Type Parameters:

TParameter - The type of an instance that is passed to the body of the loop.

Enclosing class:

ThreadedCalculation

public abstract static class ThreadedCalculation.BodyCallbackWithProgress<TParameter>
extends Delegate

A delegate representing the body of a multithreaded 'for' loop, where each iteration of the loop intends to provide detailed information about its progress. This is useful when the parallel loop has too few iterations to accurately compute progress as the number of completed iterations divided by the total number of iterations. The execution of the callback will see a ThreadingPolicy with only one thread unless it is explicitly set inside the callback.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter> A functional interface for the containing delegate type.

Constructor Summary

Constructors

Constructor and Description
BodyCallbackWithProgress() Creates a new instance of this delegate.
BodyCallbackWithProgress(Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Initializes a delegate that will invoke a static method on a class.
BodyCallbackWithProgress(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 void	invoke(TParameter parameter, int i, ITrackCalculationProgress tracker) A delegate representing the body of a multithreaded 'for' loop, where each iteration of the loop intends to provide detailed information about its progress.
static <TParameter> ThreadedCalculation.BodyCallbackWithProgress<TParameter>	of(ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter> f) Create a delegate for the given interface.
static <TParameter> ThreadedCalculation.BodyCallbackWithProgress<TParameter>	of(ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter> f, Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Create a delegate for the given interface.
static <TParameter> ThreadedCalculation.BodyCallbackWithProgress<TParameter>	of(ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter> 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

BodyCallbackWithProgress

public BodyCallbackWithProgress()

Creates a new instance of this delegate.

BodyCallbackWithProgress

public BodyCallbackWithProgress(@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.

BodyCallbackWithProgress

public BodyCallbackWithProgress(@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 void invoke(TParameter parameter,
                            int i,
                            @Nullable
                            ITrackCalculationProgress tracker)

A delegate representing the body of a multithreaded 'for' loop, where each iteration of the loop intends to provide detailed information about its progress. This is useful when the parallel loop has too few iterations to accurately compute progress as the number of completed iterations divided by the total number of iterations. The execution of the callback will see a ThreadingPolicy with only one thread unless it is explicitly set inside the callback.

Parameters:

parameter - A parameter that is passed to the body of the loop. If this instance implements IThreadAware and IsThreadSafe (get) returns false, a copy of the parameter is made for each thread using CopyForAnotherThread.

i - The index to evaluate.

tracker - The object to which progress is reported and that is able to cancel this operation before it is complete, or null.

of

@Nonnull
public static <TParameter> ThreadedCalculation.BodyCallbackWithProgress<TParameter> of(@Nonnull
                                                                                                 ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter> 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 <TParameter> ThreadedCalculation.BodyCallbackWithProgress<TParameter> of(@Nonnull
                                                                                                 ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter> 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 <TParameter> ThreadedCalculation.BodyCallbackWithProgress<TParameter> of(@Nonnull
                                                                                                 ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter> 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.