io.magus.methodmap

Class AbstractMethodMap<K>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,MethodHandleInfo>

io.magus.methodmap.AbstractMethodMap<K>

Type Parameters:

K - Type of the keys contained by the MethodMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<K,MethodHandleInfo>

Direct Known Subclasses:

AutoInstantiatingMethodMap, BoundMethodMap

public abstract class AbstractMethodMap<K>
extends java.util.HashMap<K,MethodHandleInfo>

Base class for implementations of a MethodMap

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMethodMap(java.lang.Object target, java.util.Collection<java.lang.reflect.Method> methods, MapEntryKeyFactory<K> entryKeyFactory, java.lang.invoke.MethodHandles.Lookup lookup)

Method Summary

Modifier and Type	Method and Description
MethodHandleInfo	getMethodHandleInfo(K key) Retrieves the methodhandleinfo mapped to the provided key.
abstract java.lang.Object	invoke(K key, ArgsFactory argsFactory) Invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with arguments produced by the given argsfactory.
abstract java.lang.Object	invoke(K key, java.lang.Object... args) Invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with the given arguments.
protected java.lang.Object	invoke(MethodHandleInfo methodHandleInfo, ArgsFactory argsFactory) Invokes the methodhandle contained in the provided methodhandleinfo with the arguments produced by the provided argsfactory.
protected java.lang.Object	invoke(MethodHandleInfo methodHandleInfo, java.lang.Object... args) Invokes the methodhandle contained in the provided methodhandleinfo with the provided arguments.
abstract java.lang.Object	invoke(java.lang.Object... args) Treats the first argument as the key, the remaining arguments as the methodhandle arguments, and invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with the given arguments.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

AbstractMethodMap

protected AbstractMethodMap(java.lang.Object target,
                            java.util.Collection<java.lang.reflect.Method> methods,
                            MapEntryKeyFactory<K> entryKeyFactory,
                            java.lang.invoke.MethodHandles.Lookup lookup)
                     throws DuplicateKeyException,
                            java.lang.IllegalAccessException,
                            MapEntryKeyProductionException

Parameters:

target - the target object to which all non-static methodhandles will be bound

methods - the methods that will be included in the map

entryKeyFactory - the factory used to generate keys for each of the provided methods

lookup - the lookup object used to convert the provided methods to methodhandles

Throws:

DuplicateKeyException - If more than one of the same key is generated for the entries of the methodmap.

java.lang.IllegalAccessException - If MethodHandle lookup fails for any of the provided methods.

MapEntryKeyProductionException - If entry keys fail to be generated for any of the provided methods.

Method Detail

getMethodHandleInfo

public MethodHandleInfo getMethodHandleInfo(K key)
                                     throws UnmappedKeyException

Retrieves the methodhandleinfo mapped to the provided key.

Parameters:

key - the key to which the desired methodhandleinfo is mapped

Returns:

the methodhandleinfo mapped to the provided key

Throws:

UnmappedKeyException - If there is no methodhandleinfo mapped to the provided key.

invoke

protected java.lang.Object invoke(MethodHandleInfo methodHandleInfo,
                                  java.lang.Object... args)
                           throws InvocationException

Invokes the methodhandle contained in the provided methodhandleinfo with the provided arguments.

Parameters:

methodHandleInfo - the methodhandleinfo containing the methodhandle to be invoked

args - the arguments to be passed to the methodhandle

Returns:

the result of executing the methodhandle with the provided arguments

Throws:

InvocationException - If invocation fails.

invoke

protected java.lang.Object invoke(MethodHandleInfo methodHandleInfo,
                                  ArgsFactory argsFactory)
                           throws ArgsProductionException,
                                  InvocationException

Invokes the methodhandle contained in the provided methodhandleinfo with the arguments produced by the provided argsfactory.

Parameters:

methodHandleInfo - the methodhandleinfo containing the methodhandle to be invoked

argsFactory - Produces the arguments that are passed to the methodhandle.

Returns:

the result of executing the methodhandle with the produced arguments

Throws:

ArgsProductionException - If the argsfactory fails to produce arguments.

InvocationException - If invocation fails.

invoke

public abstract java.lang.Object invoke(K key,
                                        java.lang.Object... args)
                                 throws UnmappedKeyException,
                                        InvocationException

Invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with the given arguments.

Parameters:

key - the key to which the desired methodhandleinfo is mapped

args - the arguments to be passed to the methodhandle

Returns:

the result of executing the methodhandle with the provided arguments

Throws:

InvocationException - If invocation fails.

UnmappedKeyException - If there is no methodhandleinfo associated with the provided key.

invoke

public abstract java.lang.Object invoke(K key,
                                        ArgsFactory argsFactory)
                                 throws UnmappedKeyException,
                                        ArgsProductionException,
                                        InvocationException

Invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with arguments produced by the given argsfactory.

Parameters:

key - the key to which the desired methodhandleinfo is mapped

argsFactory - Produces the arguments that are passed to the methodhandle.

Returns:

the result of executing the methodhandle with the produced arguments

Throws:

ArgsProductionException - If the argsfactory fails to produce arguments.

InvocationException - If invocation fails.

UnmappedKeyException - If there is no methodhandleinfo associated with the provided key.

invoke

public abstract java.lang.Object invoke(java.lang.Object... args)
                                 throws UnmappedKeyException,
                                        InvocationException

Treats the first argument as the key, the remaining arguments as the methodhandle arguments, and invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with the given arguments.

Parameters:

args - the key to which the desired methodhandleinfo is mapped and the arguments to be passed to the methodhandle

Returns:

the result of executing the methodhandle with the provided arguments

Throws:

InvocationException - If invocation fails.

UnmappedKeyException - If there is no methodhandleinfo associated with the provided key.