Package ball.util

Class Factory<T>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<Class<?>[],Member>

ball.util.Factory<T>

Type Parameters:

T - The type of Object this Factory will produce.

All Implemented Interfaces:

Serializable, Cloneable, Map<Class<?>[],Member>, NavigableMap<Class<?>[],Member>, SortedMap<Class<?>[],Member>

public class Factory<T>
extends TreeMap<Class<?>[],Member>

Factory base class.

Author:

Allen D. Ball

See Also:

Serialized Form

Nested Class Summary

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

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Constructor Summary

Constructors

Modifier	Constructor	Description
	Factory(Class<? extends T> type)	Sole public constructor.
protected	Factory(Class<? extends T> type, Object factory)	Construct a Factory by wrapping a factory instance.

Method Summary

Modifier and Type	Method	Description
T	apply(Member member, Object... arguments)	Method to apply a factory Member (factory Method, static Method, or Constructor) to manufacture or get an Object.
Member	get(Object key)
Object	getFactory()	Method to get the underlying factory Object.
Member	getFactoryMethod(Class<?>... parameters)	Method to get a factory Member (factory Method, static Method, or Constructor) to manufacture or get an Object.
T	getInstance(Class<?>[] parameters, Object... arguments)	Method to get an Object instance.
T	getInstance(Object... arguments)	Method to get an Object instance.
Class<? extends T>	getType()	Method to get the type (Class) of objects produced by this Factory.
boolean	hasFactoryMethodFor(Class<?>... parameters)	Method to determine if there is a factory Member (factory Method, static Method, or Constructor) to manufacture or get an Object.
protected static boolean	isApplicable(Class<?>[] parameters, Class<?>... arguments)	Method to determine if an argument of the specified types may be applied to a method or constructor with the specified parameters.
protected static Class<?>[]	typesOf(Object... arguments)	Convenience method to get the types of an argument array.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

Factory

@ConstructorProperties("type")
public Factory(Class<? extends T> type)

Sole public constructor.

Parameters:

type - The Class of Object this Factory will produce.

Throws:

NullPointerException - If type is null.

Factory

@ConstructorProperties({"type","factory"})
protected Factory(Class<? extends T> type,
                  Object factory)

Construct a Factory by wrapping a factory instance.

Parameters:

type - The Class of Object this Factory will produce.

factory - An Object factory for this type (may be null).

Throws:

NullPointerException - If type is null.

Method Detail

getType

public Class<? extends T> getType()

Method to get the type (Class) of objects produced by this Factory.

Returns:

The type of Object produced by this Factory.

getFactory

public Object getFactory()

Method to get the underlying factory Object.

Returns:

The underlying factory Object or null if there is none.

getInstance

public T getInstance(Class<?>[] parameters,
                     Object... arguments)
              throws IllegalAccessException,
                     IllegalArgumentException,
                     InstantiationException,
                     InvocationTargetException,
                     NoSuchMethodException

Method to get an Object instance. This method will first attempt to find and invoke a static factory method. If no factory method is found, it will then attempt to construct a new instance.

Parameters:

parameters - The parameter types to use to search for the Object static factory method or constructor.

arguments - The arguments to the Object static factory method or constructor.

Returns:

The Object instance.

Throws:

IllegalAccessException - If the specified Constructor or Method enforces Java language access control and the underlying Constructor or Method is inaccessible.

IllegalArgumentException - If the number of actual and formal parameters differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion; if this Constructor or Method pertains to an Enum type.

InstantiationException - If the underlying Constructor or Method represents an abstract Class.

InvocationTargetException - If the underlying Constructor or Method fails for some reason.

NoSuchMethodException - If the specified Constructor or Method does not exist.

getInstance

public T getInstance(Object... arguments)
              throws IllegalAccessException,
                     IllegalArgumentException,
                     InstantiationException,
                     InvocationTargetException,
                     NoSuchMethodException

Method to get an Object instance. This method will first attempt to find and invoke a static factory method. If no factory method is found, it will then attempt to construct a new instance.

Parameters:

arguments - The arguments to the Object static factory method or constructor.

Returns:

The Object instance.

Throws:

IllegalAccessException - If the specified Constructor or Method enforces Java language access control and the underlying Constructor or Method is inaccessible.

IllegalArgumentException - If the number of actual and formal parameters differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion; if this Constructor or Method pertains to an Enum type.

InstantiationException - If the underlying Constructor or Method represents an abstract Class.

InvocationTargetException - If the underlying Constructor or Method fails for some reason.

NoSuchMethodException - If the specified Constructor or Method does not exist.

hasFactoryMethodFor

public boolean hasFactoryMethodFor(Class<?>... parameters)

Method to determine if there is a factory Member (factory Method, static Method, or Constructor) to manufacture or get an Object.

Parameters:

parameters - The Constructor or Method parameter list.

Returns:

true if there is such a Member; false otherwise.

getFactoryMethod

public Member getFactoryMethod(Class<?>... parameters)
                        throws NoSuchMethodException

Method to get a factory Member (factory Method, static Method, or Constructor) to manufacture or get an Object.

Parameters:

parameters - The Constructor or Method parameter list.

Returns:

The factory Member.

Throws:

NoSuchMethodException - If the specified Constructor or Method does not exist.

apply

public T apply(Member member,
               Object... arguments)
        throws IllegalAccessException,
               InstantiationException,
               InvocationTargetException

Method to apply a factory Member (factory Method, static Method, or Constructor) to manufacture or get an Object.

Parameters:

member - The Member (Constructor or static Method) to invoke.

arguments - The array of arguments to apply.

Returns:

The Object instance.

Throws:

IllegalAccessException - If the specified Constructor or Method enforces Java language access control and the underlying Constructor or Method is inaccessible.

InstantiationException - If the underlying Constructor or Method represents an abstract Class.

InvocationTargetException - If the underlying Constructor or Method fails for some reason.

get

public Member get(Object key)

Specified by:

get in interface Map<Class<?>[],Member>

Overrides:

get in class TreeMap<Class<?>[],Member>

typesOf

protected static Class<?>[] typesOf(Object... arguments)

Convenience method to get the types of an argument array.

Parameters:

arguments - The argument array.

Returns:

An array of types (Classs).

isApplicable

protected static boolean isApplicable(Class<?>[] parameters,
                                      Class<?>... arguments)

Method to determine if an argument of the specified types may be applied to a method or constructor with the specified parameters.

Parameters:

parameters - The parameter types.

arguments - The argument types.

Returns:

true if the length of the argument array is the same as the length of the parameter array and each parameter is assignable from its corresponding argument; false otherwise.

See Also:

Class.isAssignableFrom(Class)