agi.foundation.compatibility

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

Class Action

java.lang.Object

agi.foundation.compatibility.Delegate

agi.foundation.compatibility.Action

All Implemented Interfaces:

Runnable

public abstract class Action
extends Delegate
implements Runnable

Represents a method that takes no parameters and does not return a value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Action.Function A functional interface for the containing delegate type.

Constructor Summary

Constructors

Constructor and Description
Action() Creates a new instance of this delegate.
Action(Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Initializes a delegate that will invoke a static method on a class.
Action(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
static Action	combine(Action a, Action b) Combines two delegate instances, forming a new delegate that will invoke both delegates when invoked.
abstract void	invoke() Represents a method that takes no parameters and does not return a value.
static Action	of(Action.Function f) Create a delegate for the given interface.
static Action	of(Action.Function f, Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Create a delegate for the given interface.
static Action	of(Action.Function f, Object targetObject, String methodName, Class<?>... methodParameterClasses) Create a delegate for the given interface.
static Action	remove(Action source, Action value) Removes one delegate from another, if it was previously combined.
void	run() When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.

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

Action

public Action()

Creates a new instance of this delegate.

Action

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

Action

public Action(@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()

Represents a method that takes no parameters and does not return a value.

run

public final void run()

Description copied from interface: java.lang.Runnable

When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.

The general contract of the method run is that it may take any action whatsoever.

Specified by:

run in interface Runnable

See Also:

Thread.run()

combine

@Nullable
public static Action combine(@Nullable
                                        Action a,
                                        @Nullable
                                        Action b)

Combines two delegate instances, forming a new delegate that will invoke both delegates when invoked.

Parameters:

a - The delegate which will be invoked first.

b - The delegate which will be invoked last.

Returns:

A new delegate that will invoke a, then b, in that order. Returns a if b is null, returns b if a is null, and returns null if both a and b are null.

remove

@Nullable
public static Action remove(@Nullable
                                       Action source,
                                       @Nullable
                                       Action value)

Removes one delegate from another, if it was previously combined.

Parameters:

source - The delegate from which to remove value.

value - The delegate to remove from source.

Returns:

A new delegate formed by removing value from source, if value is found within source. Returns source if value is null, null if source is the same as value, or if source is null.

of

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