org.apache.commons.jexl2.internal.introspection

Class ClassMap

java.lang.Object

org.apache.commons.jexl2.internal.introspection.ClassMap

final class ClassMap
extends java.lang.Object

A cache of introspection information for a specific class instance. Keys objects by an agregation of the method name and the classes that make up the parameters.

Originally taken from the Velocity tree so we can be self-sufficient.

Since:

1.0

See Also:

MethodKey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ClassMap.MethodCache This is the cache to store and look up the method information.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.reflect.Field>	fieldCache cache of fields.
private ClassMap.MethodCache	methodCache cache of methods.

Constructor Summary

Constructors

Constructor and Description
ClassMap(java.lang.Class<?> aClass, org.apache.commons.logging.Log log) Standard constructor.

Method Summary

Modifier and Type	Method and Description
private static java.util.Map<java.lang.String,java.lang.reflect.Field>	createFieldCache(java.lang.Class<?> clazz) Creates a map of all public fields of a given class.
private static ClassMap.MethodCache	createMethodCache(java.lang.Class<?> classToReflect, org.apache.commons.logging.Log log) Populate the Map of direct hits.
(package private) java.lang.reflect.Field	findField(java.lang.Class<?> clazz, java.lang.String fname) Find a Field using its name.
(package private) java.lang.reflect.Method	findMethod(MethodKey key) Find a Method using the method name and parameter objects.
(package private) java.lang.reflect.Method[]	get(java.lang.String methodName) Gets all the methods with a given name from this map.
(package private) java.lang.String[]	getFieldNames() Gets the field names cached by this map.
(package private) java.lang.String[]	getMethodNames() Gets the methods names cached by this map.
private static void	populateMethodCacheWith(ClassMap.MethodCache cache, java.lang.Class<?> clazz, org.apache.commons.logging.Log log) Recurses up class hierarchy to get all super classes.
private static void	populateMethodCacheWithInterface(ClassMap.MethodCache cache, java.lang.Class<?> iface, org.apache.commons.logging.Log log) Recurses up interface hierarchy to get all super interfaces.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

methodCache

private final ClassMap.MethodCache methodCache

cache of methods.

fieldCache

private final java.util.Map<java.lang.String,java.lang.reflect.Field> fieldCache

cache of fields.

Constructor Detail

ClassMap

ClassMap(java.lang.Class<?> aClass,
         org.apache.commons.logging.Log log)

Standard constructor.

Parameters:

aClass - the class to deconstruct.

log - the logger.

Method Detail

findField

java.lang.reflect.Field findField(java.lang.Class<?> clazz,
                                  java.lang.String fname)

Find a Field using its name.

The clazz parameter must be this ClassMap key.

Parameters:

clazz - the class to introspect

fname - the field name

Returns:

A Field object representing the field to invoke or null.

getFieldNames

java.lang.String[] getFieldNames()

Gets the field names cached by this map.

Returns:

the array of field names

createFieldCache

private static java.util.Map<java.lang.String,java.lang.reflect.Field> createFieldCache(java.lang.Class<?> clazz)

Creates a map of all public fields of a given class.

Parameters:

clazz - the class to introspect

Returns:

the map of fields (may be the empty map, can not be null)

getMethodNames

java.lang.String[] getMethodNames()

Gets the methods names cached by this map.

Returns:

the array of method names

get

java.lang.reflect.Method[] get(java.lang.String methodName)

Gets all the methods with a given name from this map.

Parameters:

methodName - the seeked methods name

Returns:

the array of methods

findMethod

java.lang.reflect.Method findMethod(MethodKey key)
                             throws MethodKey.AmbiguousException

Find a Method using the method name and parameter objects.

Parameters:

key - the method key

Returns:

A Method object representing the method to invoke or null.

Throws:

MethodKey.AmbiguousException - When more than one method is a match for the parameters.

createMethodCache

private static ClassMap.MethodCache createMethodCache(java.lang.Class<?> classToReflect,
                                                      org.apache.commons.logging.Log log)

Populate the Map of direct hits. These are taken from all the public methods that our class, its parents and their implemented interfaces provide.

Parameters:

classToReflect - the class to cache

log - the Log

Returns:

a newly allocated & filled up cache

populateMethodCacheWithInterface

private static void populateMethodCacheWithInterface(ClassMap.MethodCache cache,
                                                     java.lang.Class<?> iface,
                                                     org.apache.commons.logging.Log log)

Recurses up interface hierarchy to get all super interfaces.

Parameters:

cache - the cache to fill

iface - the interface to populate the cache from

log - the Log

populateMethodCacheWith

private static void populateMethodCacheWith(ClassMap.MethodCache cache,
                                            java.lang.Class<?> clazz,
                                            org.apache.commons.logging.Log log)

Recurses up class hierarchy to get all super classes.

Parameters:

cache - the cache to fill

clazz - the class to populate the cache from

log - the Log