agi.foundation.compatibility

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

Class EventHandler<TEventArgs extends EventArgs>

java.lang.Object

agi.foundation.compatibility.Delegate

agi.foundation.compatibility.EventHandler<TEventArgs>

Type Parameters:

TEventArgs - The type of event data generated by the event.

public abstract class EventHandler<TEventArgs extends EventArgs>
extends Delegate

Represents a method that will handle an event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventHandler.Function<TEventArgs extends EventArgs> A functional interface for the containing delegate type.

Constructor Summary

Constructors

Constructor and Description
EventHandler() Creates a new instance of this delegate.
EventHandler(Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Initializes a delegate that will invoke a static method on a class.
EventHandler(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 <TEventArgs extends EventArgs> EventHandler<TEventArgs>	combine(EventHandler<TEventArgs> a, EventHandler<TEventArgs> b) Combines two delegate instances, forming a new delegate that will invoke both delegates when invoked.
abstract void	invoke(Object sender, TEventArgs e) Represents a method that will handle an event.
static <TEventArgs extends EventArgs> EventHandler<TEventArgs>	of(EventHandler.Function<TEventArgs> f) Create a delegate for the given interface.
static <TEventArgs extends EventArgs> EventHandler<TEventArgs>	of(EventHandler.Function<TEventArgs> f, Class<?> targetClass, String methodName, Class<?>... methodParameterClasses) Create a delegate for the given interface.
static <TEventArgs extends EventArgs> EventHandler<TEventArgs>	of(EventHandler.Function<TEventArgs> f, Object targetObject, String methodName, Class<?>... methodParameterClasses) Create a delegate for the given interface.
static <TEventArgs extends EventArgs> EventHandler<TEventArgs>	remove(EventHandler<TEventArgs> source, EventHandler<TEventArgs> value) Removes one delegate from another, if it was previously combined.

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

EventHandler

public EventHandler()

Creates a new instance of this delegate.

EventHandler

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

EventHandler

public EventHandler(@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(Object sender,
                            TEventArgs e)

Represents a method that will handle an event.

Parameters:

sender - The source of the event.

e - An object that contains the event data.

combine

@Nullable
public static <TEventArgs extends EventArgs> EventHandler<TEventArgs> combine(@Nullable
                                                                                         EventHandler<TEventArgs> a,
                                                                                         @Nullable
                                                                                         EventHandler<TEventArgs> 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 <TEventArgs extends EventArgs> EventHandler<TEventArgs> remove(@Nullable
                                                                                        EventHandler<TEventArgs> source,
                                                                                        @Nullable
                                                                                        EventHandler<TEventArgs> 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 <TEventArgs extends EventArgs> EventHandler<TEventArgs> of(@Nonnull
                                                                                   EventHandler.Function<TEventArgs> 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 <TEventArgs extends EventArgs> EventHandler<TEventArgs> of(@Nonnull
                                                                                   EventHandler.Function<TEventArgs> 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 <TEventArgs extends EventArgs> EventHandler<TEventArgs> of(@Nonnull
                                                                                   EventHandler.Function<TEventArgs> 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.