io.magus.methodmap

Class AutoInstantiatingMethodMap<K>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,MethodHandleInfo>

io.magus.methodmap.AbstractMethodMap<K>

io.magus.methodmap.AutoInstantiatingMethodMap<K>

Type Parameters:

K - Type of the keys contained in the MethodMap

All Implemented Interfaces:

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

public class AutoInstantiatingMethodMap<K>
extends AbstractMethodMap<K>

MethodMap that automatically instantiates an object of the appropriate class when invoking non-static methods. Supports the instantiation of objects with specific constructors and arguments if available for the desired class.

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

Constructor and Description
AutoInstantiatingMethodMap(MapEntryKeyFactory<K> entryKeyFactory, MethodCollectionFactory methodCollectionFactory, java.lang.invoke.MethodHandles.Lookup lookup)

Method Summary

Modifier and Type	Method and Description
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.
java.lang.Object	invoke(K key, java.lang.Class<?>[] constructorParameterTypes, java.lang.Object[] constructorArgs, ArgsFactory argsFactory) Invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with the arguments produced by the given argsfactory.
java.lang.Object	invoke(K key, java.lang.Class<?>[] constructorParameterTypes, java.lang.Object[] constructorArgs, java.lang.Object... args) Invokes the methodhandle contained in the methodhandleinfo mapped to the provided key with the given arguments.
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.Class<?>[] constructorParameterTypes, java.lang.Object[] constructorArgs, ArgsFactory argsFactory) Invokes the methodhandle contained in the provided methodhandleinfo with the arguments produced by the given argsfactory.
protected java.lang.Object	invoke(MethodHandleInfo methodHandleInfo, java.lang.Class<?>[] constructorParameterTypes, java.lang.Object[] constructorArgs, java.lang.Object... args) Invokes the methodhandle contained in the provided methodhandleinfo with the given arguments.
protected java.lang.Object	invoke(MethodHandleInfo methodHandleInfo, java.lang.Object... args) Invokes the methodhandle contained in the provided methodhandleinfo with the provided arguments.
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 io.magus.methodmap.AbstractMethodMap

getMethodHandleInfo

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

AutoInstantiatingMethodMap

public AutoInstantiatingMethodMap(MapEntryKeyFactory<K> entryKeyFactory,
                                  MethodCollectionFactory methodCollectionFactory,
                                  java.lang.invoke.MethodHandles.Lookup lookup)
                           throws DuplicateKeyException,
                                  MethodCollectionProductionException,
                                  java.lang.IllegalAccessException,
                                  MapEntryKeyProductionException

Parameters:

entryKeyFactory - factory used to generate keys for each of the methods produced by methodCollectionFactory

methodCollectionFactory - Produces a collection of methods that will be included in this methodmap.

lookup - the lookup object used to convert the produced methods into methodhandles

Throws:

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

MethodCollectionProductionException - If the methodcollectionfactory fails to produce a method collection.

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

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

Method Detail

invoke

protected java.lang.Object invoke(MethodHandleInfo methodHandleInfo,
                                  java.lang.Class<?>[] constructorParameterTypes,
                                  java.lang.Object[] constructorArgs,
                                  java.lang.Object... args)
                           throws java.lang.NoSuchMethodException,
                                  java.lang.SecurityException,
                                  java.lang.InstantiationException,
                                  java.lang.IllegalAccessException,
                                  java.lang.IllegalArgumentException,
                                  java.lang.reflect.InvocationTargetException,
                                  InvocationException

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

Attempts to instantiate an object with the provided constructor parameter types and arguments if the underlying method is non-static.

Parameters:

methodHandleInfo - the methodhandleinfo containing the methodhandle to be invoked

constructorParameterTypes - the parameter types of the desired constructor

constructorArgs - the arguments to be passed to the desired constructor

args - the arguments to be passed to the methodhandle

Returns:

the result of invoking the methodhandle with the provided arguments

Throws:

java.lang.SecurityException - See the documentation for Class.getConstructor(Class...).

java.lang.NoSuchMethodException - See the documentation for Class.getConstructor(Class...).

java.lang.reflect.InvocationTargetException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalArgumentException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalAccessException - See the documentation for Constructor.newInstance(Object...).

java.lang.InstantiationException - See the documentation for Constructor.newInstance(Object...).

InvocationException - If methodhandle invocation fails.

invoke

protected java.lang.Object invoke(MethodHandleInfo methodHandleInfo,
                                  java.lang.Class<?>[] constructorParameterTypes,
                                  java.lang.Object[] constructorArgs,
                                  ArgsFactory argsFactory)
                           throws java.lang.NoSuchMethodException,
                                  java.lang.SecurityException,
                                  java.lang.InstantiationException,
                                  java.lang.IllegalAccessException,
                                  java.lang.IllegalArgumentException,
                                  java.lang.reflect.InvocationTargetException,
                                  ArgsProductionException,
                                  InvocationException

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

Attempts to instantiate an object with the provided constructor parameter types and arguments if the underlying method is non-static.

Parameters:

methodHandleInfo - the methodhandleinfo containing the methodhandle to be invoked

constructorParameterTypes - the parameter types of the desired constructor

constructorArgs - the arguments to be passed to the desired constructor

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

Returns:

the result of invoking the methodhandle with the produced arguments

Throws:

java.lang.reflect.InvocationTargetException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalArgumentException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalAccessException - See the documentation for Constructor.newInstance(Object...).

java.lang.InstantiationException - See the documentation for Constructor.newInstance(Object...).

java.lang.SecurityException - See the documentation for Class.getConstructor(Class...).

java.lang.NoSuchMethodException - See the documentation for Class.getConstructor(Class...).

ArgsProductionException - If the argsfactory fails to produce arguments.

InvocationException - If methodhandle invocation fails.

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.

Convenience method for instantiating objects with the default constructor when the underlying method is non-static.

Equivalent to calling invoke(MethodHandleInfo, null, null, Object...)

Overrides:

invoke in class AbstractMethodMap<K>

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.

Convenience method for instantiating objects with the default constructor when the underlying method is non-static.

Equivalent to calling invoke(MethodHandleInfo, null, null, ArgsFactory)

Overrides:

invoke in class AbstractMethodMap<K>

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 java.lang.Object invoke(K key,
                               java.lang.Class<?>[] constructorParameterTypes,
                               java.lang.Object[] constructorArgs,
                               java.lang.Object... args)
                        throws java.lang.NoSuchMethodException,
                               java.lang.SecurityException,
                               java.lang.InstantiationException,
                               java.lang.IllegalAccessException,
                               java.lang.IllegalArgumentException,
                               java.lang.reflect.InvocationTargetException,
                               UnmappedKeyException,
                               InvocationException

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

Attempts to instantiate an object with the provided constructor parameter types and arguments if the underlying method is non-static.

Parameters:

key - the key to which the desired methodhandleinfo is mapped

constructorParameterTypes - the parameter types of the desired constructor

constructorArgs - the arguments to be passed to the desired constructor

args - the arguments to be passed to the methodhandle

Returns:

the result of invoking the methodhandle with the provided arguments

Throws:

java.lang.reflect.InvocationTargetException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalArgumentException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalAccessException - See the documentation for Constructor.newInstance(Object...).

java.lang.InstantiationException - See the documentation for Constructor.newInstance(Object...).

java.lang.SecurityException - See the documentation for Class.getConstructor(Class...).

java.lang.NoSuchMethodException - See the documentation for Class.getConstructor(Class...).

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

InvocationException - If methodhandle invocation fails.

invoke

public java.lang.Object invoke(K key,
                               java.lang.Class<?>[] constructorParameterTypes,
                               java.lang.Object[] constructorArgs,
                               ArgsFactory argsFactory)
                        throws java.lang.NoSuchMethodException,
                               java.lang.SecurityException,
                               java.lang.InstantiationException,
                               java.lang.IllegalAccessException,
                               java.lang.IllegalArgumentException,
                               java.lang.reflect.InvocationTargetException,
                               ArgsProductionException,
                               UnmappedKeyException,
                               InvocationException

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

Attempts to instantiate an object with the provided constructor parameter types and arguments if the underlying method is non-static.

Parameters:

key - the key to which the desired methodhandleinfo is mapped

constructorParameterTypes - the parameter types of the desired constructor

constructorArgs - the arguments to be passed to the desired constructor

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

Returns:

the result of invoking the methodhandle with the produced arguments

Throws:

java.lang.reflect.InvocationTargetException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalArgumentException - See the documentation for Constructor.newInstance(Object...).

java.lang.IllegalAccessException - See the documentation for Constructor.newInstance(Object...).

java.lang.InstantiationException - See the documentation for Constructor.newInstance(Object...).

java.lang.SecurityException - See the documentation for Class.getConstructor(Class...).

java.lang.NoSuchMethodException - See the documentation for Class.getConstructor(Class...).

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

ArgsProductionException - If the argsfactory fails to produce arguments.

InvocationException - If methodhandle invocation fails.

invoke

public 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.

Convenience method for instantiating objects with the default constructor when the underlying method in non-static.

Equivalent to calling invoke(Object, null, null, Object...)

Specified by:

invoke in class AbstractMethodMap<K>

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:

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

InvocationException - If invocation fails.

invoke

public 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.

Convenience method for instantiating objects with the default constructor when the underlying method in non-static.

Equivalent to calling invoke(Object, null, null, ArgsFactory)

Specified by:

invoke in class AbstractMethodMap<K>

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:

java.lang.IllegalArgumentException - See the documentation for Constructor.newInstance(Object...).

java.lang.SecurityException - See the documentation for Class.getConstructor(Class...).

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

ArgsProductionException - If the argsfactory fails to produce arguments.

InvocationException - If invocation fails.

invoke

public 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.

Uses the default constructor for non-static methods.

Specified by:

invoke in class AbstractMethodMap<K>

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:

java.lang.IllegalArgumentException - See the documentation for Constructor.newInstance(Object...).

java.lang.SecurityException - See the documentation for Class.getConstructor(Class...).

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

InvocationException - If invocation fails.