Class IntrospectionUtils
java.lang.Object
org.apache.tomcat.util.IntrospectionUtils
Utils for introspection and reflection
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceInterface for a source of named properties used during introspection. -
Method Summary
Modifier and TypeMethodDescriptionstatic ObjectcallMethod1(Object target, String methodN, Object param1, String typeParam1, ClassLoader cl) Call a method with a single parameter on the given target object.static ObjectcallMethodN(Object target, String methodN, Object[] params, Class<?>[] typeParams) Call a method with multiple parameters on the given target object.static Stringcapitalize(String name) Reverse of Introspector.decapitalize.static voidclear()Clear the internal method cache.static ObjectConvert a string value to the specified type.static StringEscapes special characters in a string for use in generated code.static MethodfindMethod(Class<?> c, String name, Class<?>[] params) Find a specific method by name and parameter types.static Method[]findMethods(Class<?> c) Find all public methods of the given class, using a cache for performance.static ObjectgetProperty(Object o, String name) Get the value of a property from the given object.static booleanisInstance(Class<?> clazz, String type) Checks to see if the specified class is an instance of or assignable from the specified type.static StringreplaceProperties(String value, Hashtable<Object, Object> staticProp, IntrospectionUtils.PropertySource[] dynamicProp, ClassLoader classLoader) Replaces ${NAME} in the value with the value of the property 'NAME'.static booleansetProperty(Object o, String name, String value) Find a method with the right name If found, call the method ( if param is int or boolean we'll convert value to the right type before) - that means you can have setDebug(1).static booleansetProperty(Object o, String name, String value, boolean invokeSetProperty) Set a property on the given object.static booleansetProperty(Object o, String name, String value, boolean invokeSetProperty, StringBuilder actualMethod) Set a property on the given object, tracking the actual method called.
-
Method Details
-
setProperty
Find a method with the right name If found, call the method ( if param is int or boolean we'll convert value to the right type before) - that means you can have setDebug(1).- Parameters:
o- The object to set a property onname- The property namevalue- The property value- Returns:
trueif operation was successful
-
setProperty
Set a property on the given object.- Parameters:
o- the object to set the property onname- the property namevalue- the property valueinvokeSetProperty- whether to invoke setProperty as a fallback- Returns:
trueif the operation was successful
-
setProperty
public static boolean setProperty(Object o, String name, String value, boolean invokeSetProperty, StringBuilder actualMethod) Set a property on the given object, tracking the actual method called.- Parameters:
o- the object to set the property onname- the property namevalue- the property valueinvokeSetProperty- whether to invoke setProperty as a fallbackactualMethod- StringBuilder to append the actual method call to, ornull- Returns:
trueif the operation was successful
-
escape
-
getProperty
-
replaceProperties
public static String replaceProperties(String value, Hashtable<Object, Object> staticProp, IntrospectionUtils.PropertySource[] dynamicProp, ClassLoader classLoader) Replaces ${NAME} in the value with the value of the property 'NAME'. Replaces ${NAME:DEFAULT} with the value of the property 'NAME:DEFAULT', if the property 'NAME:DEFAULT' is not set, the expression is replaced with the value of the property 'NAME', if the property 'NAME' is not set, the expression is replaced with 'DEFAULT'. If the property is not set and there is no default the value will be returned unmodified.- Parameters:
value- The valuestaticProp- Replacement propertiesdynamicProp- Replacement propertiesclassLoader- Class loader associated with the code requesting the property- Returns:
- the replacement value
-
capitalize
-
clear
public static void clear()Clear the internal method cache. -
findMethods
-
findMethod
-
callMethod1
public static Object callMethod1(Object target, String methodN, Object param1, String typeParam1, ClassLoader cl) throws Exception Call a method with a single parameter on the given target object.- Parameters:
target- the target objectmethodN- the method nameparam1- the parameter valuetypeParam1- the parameter type name, ornullto infer from the parametercl- the class loader to use for loading the parameter type- Returns:
- the result of the method call
- Throws:
Exception- if the method cannot be found or invoked
-
callMethodN
public static Object callMethodN(Object target, String methodN, Object[] params, Class<?>[] typeParams) throws Exception Call a method with multiple parameters on the given target object.- Parameters:
target- the target objectmethodN- the method nameparams- the parameter valuestypeParams- the parameter types- Returns:
- the result of the method call, or
nullif the method cannot be found - Throws:
Exception- if the method cannot be invoked
-
convert
Convert a string value to the specified type.- Parameters:
object- the string value to convertparamType- the target type- Returns:
- the converted object
- Throws:
IllegalArgumentException- if conversion fails
-
isInstance
Checks to see if the specified class is an instance of or assignable from the specified type. The classclazz, all its superclasses, interfaces and those superinterfaces are tested for a match against the type nametype. This is similar toinstanceoforClass.isAssignableFrom(Class)except that the target type will not be resolved into a Class object, which provides some security and memory benefits.- Parameters:
clazz- The class to test for a match.type- The name of the type thatclazzmust be.- Returns:
trueif theclazztested is an instance of the specifiedtype,falseotherwise.
-