ThreadedCalculation.BodyCallbackWithProgress2 | DME Component Libraries for Java 2024 r2

java.lang.Object
- agi.foundation.compatibility.Delegate
- - agi.foundation.infrastructure.threading.ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2>

Type Parameters:

TParameter1 - The type of the first instance that is passed to the body of the loop.

TParameter2 - The type of the second instance that is passed to the body of the loop.

Enclosing class:

ThreadedCalculation
```
public abstract static class ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2>
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.BodyCallbackWithProgress2.Function<TParameter1,TParameter2>` A functional interface for the containing delegate type.

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`invoke(TParameter1 parameter1, TParameter2 parameter2, 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 <TParameter1,TParameter2> ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2>`	`of(ThreadedCalculation.BodyCallbackWithProgress2.Function<TParameter1,TParameter2> f)` Create a delegate for the given interface.
`static <TParameter1,TParameter2> ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2>`	`of(ThreadedCalculation.BodyCallbackWithProgress2.Function<TParameter1,TParameter2> f, Class<?> targetClass, String methodName, Class<?>... methodParameterClasses)` Create a delegate for the given interface.
`static <TParameter1,TParameter2> ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2>`	`of(ThreadedCalculation.BodyCallbackWithProgress2.Function<TParameter1,TParameter2> 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

BodyCallbackWithProgress2
```
public BodyCallbackWithProgress2()
```
Creates a new instance of this delegate.

BodyCallbackWithProgress2

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

BodyCallbackWithProgress2

public BodyCallbackWithProgress2(@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(TParameter1 parameter1,
                            TParameter2 parameter2,
                            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:

parameter1 - The first 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.

parameter2 - The second 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 <TParameter1,TParameter2> ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2> of(@Nonnull
                                                                                                                            ThreadedCalculation.BodyCallbackWithProgress2.Function<TParameter1,TParameter2> 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 <TParameter1,TParameter2> ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2> of(@Nonnull
                                                                                                                            ThreadedCalculation.BodyCallbackWithProgress2.Function<TParameter1,TParameter2> 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 <TParameter1,TParameter2> ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2> of(@Nonnull
                                                                                                                            ThreadedCalculation.BodyCallbackWithProgress2.Function<TParameter1,TParameter2> 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.

Class ThreadedCalculation.BodyCallbackWithProgress2<TParameter1,TParameter2>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.compatibility.Delegate

Methods inherited from class java.lang.Object

Constructor Detail

BodyCallbackWithProgress2

BodyCallbackWithProgress2

BodyCallbackWithProgress2

Method Detail

invoke

of

of

of