OgnlRuntime (OGNL - Object Graph Navigation Library 3.2.21 API)

java.lang.Object
- ognl.OgnlRuntime

```
public class OgnlRuntime
extends Object
```
Utility class used by internal OGNL API to do various things like:
- Handles majority of reflection logic / caching.
- Utility methods for casting strings / various numeric types used by OgnlExpressionCompiler.
- Core runtime configuration point for setting/using global TypeConverter / OgnlExpressionCompiler / NullHandler instances / etc..
Author:

Luke Blanshard (blanshlu@netscape.net), Drew Davidson (drew@ognl.org)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OgnlRuntime.ArgsCompatbilityReport` Tells whether the given array of objects is compatible with the given array of classes---that is, whether the given array of objects can be passed as arguments to a method or constructor whose parameter types are the given array of classes.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INDEXED_PROPERTY_INT` JavaBeans IndexedProperty
`static int`	`INDEXED_PROPERTY_NONE` Not an indexed property
`static int`	`INDEXED_PROPERTY_OBJECT` OGNL ObjectIndexedProperty
`static OgnlRuntime.ArgsCompatbilityReport`	`NoArgsReport`
`static Object[]`	`NoArguments`
`static Class[]`	`NoArgumentTypes`
`static Object`	`NoConversionPossible` Token returned by TypeConverter for no conversion possible
`static Object`	`NotFound` Constant expression used to indicate that a given method / property couldn't be found during reflection operations.
`static List`	`NotFoundList`
`static Map`	`NotFoundMap`
`static String`	`NULL_STRING` Constant string representation of null string.

Constructor Summary

Constructors
Constructor and Description

OgnlRuntime()

Constructors
Constructor and Description
`OgnlRuntime()`

Method Summary

Methods
Modifier and Type	Method and Description
`static OgnlRuntime.ArgsCompatbilityReport`	`areArgsCompatible(Class[] args, Class[] classes, Method m)`
`static boolean`	`areArgsCompatible(Object[] args, Class[] classes)`
`static Object`	`callAppropriateMethod(OgnlContext context, Object source, Object target, String methodName, String propertyName, List methods, Object[] args)`
`static Object`	`callConstructor(OgnlContext context, String className, Object[] args)`
`static Object`	`callMethod(OgnlContext context, Object target, String methodName, Object[] args)` Invokes the specified method against the target object.
`static Object`	`callMethod(OgnlContext context, Object target, String methodName, String propertyName, Object[] args)` Deprecated. Use `callMethod(OgnlContext, Object, String, Object[])` instead.
`static Object`	`callStaticMethod(OgnlContext context, String className, String methodName, Object[] args)`
`static Class`	`classForName(OgnlContext context, String className)`
`static void`	`clearAdditionalCache()` Clears some additional caches used by OgnlRuntime.
`static void`	`clearCache()` Clears all of the cached reflection information normally used to improve the speed of expressions that operate on the same classes or are executed multiple times.
`static void`	`compileExpression(OgnlContext context, Node expression, Object root)`
`static Class[]`	`findParameterTypes(Class type, Method m)` Finds the appropriate parameter types for the given `Method` and `Class` instance of the type the method is associated with.
`static Map`	`getAllMethods(Class targetClass, boolean staticMethods)`
`static List`	`getAllMethods(Class targetClass, String name, boolean staticMethods)`
`static Method`	`getAppropriateMethod(OgnlContext context, Object source, Object target, String propertyName, String methodName, List methods, Object[] args, Object[] actualArgs)` Gets the appropriate method to be called for the given target, method name and arguments.
`static Class`	`getArgClass(Object arg)` Gets the class for a method argument that is appropriate for looking up methods by reflection, by looking for the standard primitive wrapper classes and exchanging for them their underlying primitive class objects.
`static Class[]`	`getArgClasses(Object[] args)`
`static String`	`getBaseName(Object o)` Returns the base name (the class name without the package name prepended) of the object given.
`static String`	`getChildSource(OgnlContext context, Object target, Node child)` Attempts to get the java source string represented by the specific child expression via the `JavaSource.toGetSourceString(OgnlContext,Object)` interface method.
`static String`	`getChildSource(OgnlContext context, Object target, Node child, boolean forceConversion)` Attempts to get the java source string represented by the specific child expression via the `JavaSource.toGetSourceString(OgnlContext,Object)` interface method.
`static String`	`getClassBaseName(Class c)` Returns the base name (the class name without the package name prepended) of the class given.
`static String`	`getClassName(Class c, boolean fullyQualified)`
`static String`	`getClassName(Object o, boolean fullyQualified)`
`static String`	`getClassPackageName(Class c)` Returns the package name of the class given.
`static OgnlExpressionCompiler`	`getCompiler()`
`static List`	`getConstructors(Class targetClass)`
`static Constructor`	`getConvertedConstructorAndArgs(OgnlContext context, Object target, List constructors, Object[] args, Object[] newArgs)`
`static Method`	`getConvertedMethodAndArgs(OgnlContext context, Object target, String propertyName, List methods, Object[] args, Object[] newArgs)`
`static Object`	`getConvertedType(OgnlContext context, Object target, Member member, String propertyName, Object value, Class type)`
`static boolean`	`getConvertedTypes(OgnlContext context, Object target, Member member, String propertyName, Class[] parameterTypes, Object[] args, Object[] newArgs)`
`static List`	`getDeclaredMethods(Class targetClass, String propertyName, boolean findSets)`
`static boolean`	`getDisableOgnlSecurityManagerOnInitValue()` Returns the value of the flag indicating whether the OGNL SecurityManager was disabled on initialization or not.
`static ElementsAccessor`	`getElementsAccessor(Class cls)`
`static EvaluationPool`	`getEvaluationPool()`
`static Field`	`getField(Class inClass, String name)`
`static Map`	`getFields(Class targetClass)`
`static Object`	`getFieldValue(OgnlContext context, Object target, String propertyName)` Deprecated.
`static Object`	`getFieldValue(OgnlContext context, Object target, String propertyName, boolean checkAccessAndExistence)`
`static Method`	`getGetMethod(OgnlContext context, Class targetClass, String propertyName)` cache get methods
`static Object`	`getIndexedProperty(OgnlContext context, Object source, String name, Object index)`
`static int`	`getIndexedPropertyType(OgnlContext context, Class sourceClass, String name)` Determines the index property type, if any.
`static int`	`getMajorJavaVersion()` Get the Major Java Version detected by OGNL.
`static Method`	`getMethod(OgnlContext context, Class target, String name, Node[] children, boolean includeStatic)`
`static MethodAccessor`	`getMethodAccessor(Class cls)`
`static Map`	`getMethods(Class targetClass, boolean staticMethods)`
`static List`	`getMethods(Class targetClass, String name, boolean staticMethods)`
`static Object`	`getMethodValue(OgnlContext context, Object target, String propertyName)` Deprecated.
`static Object`	`getMethodValue(OgnlContext context, Object target, String propertyName, boolean checkAccessAndExistence)` If the checkAccessAndExistence flag is true this method will check to see if the method exists and if it is accessible according to the context's MemberAccess.
`static String`	`getModifierString(int modifiers)`
`static NullHandler`	`getNullHandler(Class cls)`
`static String`	`getNumericCast(Class type)`
`static Object`	`getNumericDefaultValue(Class forClass)`
`static String`	`getNumericLiteral(Class type)`
`static String`	`getNumericValueGetter(Class type)`
`static ObjectArrayPool`	`getObjectArrayPool()`
`static String`	`getPackageName(Object o)` Returns the package name of the object's class.
`static Class[]`	`getParameterTypes(Constructor c)` Returns the parameter types of the given method.
`static Class[]`	`getParameterTypes(Method m)` Returns the parameter types of the given method.
`static Permission`	`getPermission(Method method)` Permission will be named "invoke.<declaring-class>.<method-name>".
`static String`	`getPointerString(int num)` Returns a "pointer" string in the usual format for these things - 0x<hex digits>.
`static String`	`getPointerString(Object o)` Returns a "pointer" string in the usual format for these things - 0x<hex digits> for the object given.
`static Object`	`getPrimitiveDefaultValue(Class forClass)`
`static Class`	`getPrimitiveWrapperClass(Class primitiveClass)`
`static PropertyDescriptor`	`getProperty(Class target, String name)`
`static Object`	`getProperty(OgnlContext context, Object source, Object name)`
`static PropertyAccessor`	`getPropertyAccessor(Class cls)`
`static PropertyDescriptor`	`getPropertyDescriptor(Class targetClass, String propertyName)` This method returns a PropertyDescriptor for the given class and property name using a Map lookup (using getPropertyDescriptorsMap()).
`static PropertyDescriptor`	`getPropertyDescriptorFromArray(Class targetClass, String name)` Gets the property descriptor with the given name for the target class given.
`static Map`	`getPropertyDescriptors(Class targetClass)` This method returns the property descriptors for the given class as a Map.
`static PropertyDescriptor[]`	`getPropertyDescriptorsArray(Class targetClass)`
`static Method`	`getReadMethod(Class target, String name)` Finds the best possible match for a method on the specified target class with a matching name.
`static Method`	`getReadMethod(Class target, String name, Class[] argClasses)`
`static SecurityManager`	`getSecurityManager()` Gets the SecurityManager that OGNL uses to determine permissions for invoking methods.
`static Method`	`getSetMethod(OgnlContext context, Class targetClass, String propertyName)` cache set methods method
`static Object`	`getStaticField(OgnlContext context, String className, String fieldName)` Method name is getStaticField(), but actually behaves more like "getStaticFieldValue()".
`static Class`	`getTargetClass(Object o)` Gets the "target" class of an object for looking up accessors that are registered on the target.
`static String`	`getUniqueDescriptor(Object object)` Returns a unique descriptor string that includes the object's class' base name and a unique integer identifier.
`static String`	`getUniqueDescriptor(Object object, boolean fullyQualified)` Returns a unique descriptor string that includes the object's class and a unique integer identifier.
`static boolean`	`getUseFirstMatchGetSetLookupValue()` Returns the value of the flag indicating whether the old "first match" lookup for getters/setters is in effect or not.
`static boolean`	`getUseJDK9PlusAccessHandlerValue()` Returns the value of the flag indicating whether the JDK9+ access handler has been been requested (it can then be used if the Major Java Version number is 9+).
`static boolean`	`getUseStricterInvocationValue()` Returns the value of the flag indicating whether "stricter" invocation is in effect or not.
`static Method`	`getWriteMethod(Class target, String name)`
`static Method`	`getWriteMethod(Class target, String name, Class[] argClasses)`
`static boolean`	`hasField(OgnlContext context, Object target, Class inClass, String propertyName)`
`static boolean`	`hasGetMethod(OgnlContext context, Object target, Class targetClass, String propertyName)`
`static boolean`	`hasGetProperty(OgnlContext context, Object target, Object oname)`
`static boolean`	`hasSetMethod(OgnlContext context, Object target, Class targetClass, String propertyName)`
`static boolean`	`hasSetProperty(OgnlContext context, Object target, Object oname)`
`static Object`	`invokeMethod(Object target, Method method, Object[] argsArray)`
`static boolean`	`isBoolean(String expression)`
`static boolean`	`isFieldAccessible(OgnlContext context, Object target, Class inClass, String propertyName)`
`static boolean`	`isFieldAccessible(OgnlContext context, Object target, Field field, String propertyName)`
`static boolean`	`isInstance(OgnlContext context, Object value, String className)`
`static boolean`	`isJdk9Plus()` Check if the detected Major Java Version is 9 or higher (JDK 9+).
`static boolean`	`isMethodAccessible(OgnlContext context, Object target, Method method, String propertyName)`
`static boolean`	`isMoreSpecific(Class[] classes1, Class[] classes2)` Tells whether the first array of classes is more specific than the second.
`static boolean`	`isTypeCompatible(Class parameterClass, Class methodArgumentClass, int index, OgnlRuntime.ArgsCompatbilityReport report)`
`static boolean`	`isTypeCompatible(Object object, Class c)` Tells whether the given object is compatible with the given class ---that is, whether the given object can be passed as an argument to a method or constructor whose parameter type is the given class.
`static void`	`setClassCacheInspector(ClassCacheInspector inspector)` Registers the specified `ClassCacheInspector` with all class reflection based internal caches.
`static void`	`setCompiler(OgnlExpressionCompiler compiler)`
`static void`	`setElementsAccessor(Class cls, ElementsAccessor accessor)`
`static boolean`	`setFieldValue(OgnlContext context, Object target, String propertyName, Object value)`
`static void`	`setIndexedProperty(OgnlContext context, Object source, String name, Object index, Object value)`
`static void`	`setMethodAccessor(Class cls, MethodAccessor accessor)`
`static boolean`	`setMethodValue(OgnlContext context, Object target, String propertyName, Object value)` Deprecated.
`static boolean`	`setMethodValue(OgnlContext context, Object target, String propertyName, Object value, boolean checkAccessAndExistence)`
`static void`	`setNullHandler(Class cls, NullHandler handler)`
`static void`	`setProperty(OgnlContext context, Object target, Object name, Object value)`
`static void`	`setPropertyAccessor(Class cls, PropertyAccessor accessor)`
`static void`	`setSecurityManager(SecurityManager value)` Sets the SecurityManager that OGNL uses to determine permissions for invoking methods.
`static boolean`	`shouldConvertNumericTypes(OgnlContext context)` Compares the `OgnlContext.getCurrentType()` and `OgnlContext.getPreviousType()` class types on the stack to determine if a numeric expression should force object conversion.
`static Object[]`	`toArray(List list)` Utility to convert a List into an Object[] array.
`static boolean`	`usingJDK9PlusAccessHandler()` Returns an indication as to whether the current state indicates the JDK9+ (9 and later) access handler is being used / should be used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NotFound
```
public static final Object NotFound
```
Constant expression used to indicate that a given method / property couldn't be found during reflection operations.

NotFoundList
```
public static final List NotFoundList
```

NotFoundMap
```
public static final Map NotFoundMap
```

NoArguments

public static final Object[] NoArguments

NoArgumentTypes

public static final Class[] NoArgumentTypes

NoConversionPossible
```
public static final Object NoConversionPossible
```
Token returned by TypeConverter for no conversion possible

INDEXED_PROPERTY_NONE
```
public static int INDEXED_PROPERTY_NONE
```
Not an indexed property

INDEXED_PROPERTY_INT
```
public static int INDEXED_PROPERTY_INT
```
JavaBeans IndexedProperty

INDEXED_PROPERTY_OBJECT
```
public static int INDEXED_PROPERTY_OBJECT
```
OGNL ObjectIndexedProperty

NULL_STRING
```
public static final String NULL_STRING
```
Constant string representation of null string.

NoArgsReport

public static final OgnlRuntime.ArgsCompatbilityReport NoArgsReport

Constructor Detail
- OgnlRuntime
```
public OgnlRuntime()
```

Method Detail

clearCache
```
public static void clearCache()
```
Clears all of the cached reflection information normally used to improve the speed of expressions that operate on the same classes or are executed multiple times.
Warning: Calling this too often can be a huge performance drain on your expressions - use with care.

clearAdditionalCache
```
public static void clearAdditionalCache()
```
Clears some additional caches used by OgnlRuntime. The existing clearCache() clears the standard reflection-related caches, but some applications may have need to clear the additional caches as well. Clearing the additional caches may have greater impact than the clearCache() method so it should only be used when the normal cache clear is insufficient.
Warning: Calling this method too often can be a huge performance drain on your expressions - use with care.

Since:

3.1.25

getMajorJavaVersion
```
public static int getMajorJavaVersion()
```
Get the Major Java Version detected by OGNL.

Returns:
Detected Major Java Version, or 5 (minimum supported version for OGNL) if unable to detect.

isJdk9Plus
```
public static boolean isJdk9Plus()
```
Check if the detected Major Java Version is 9 or higher (JDK 9+).

Returns:
Return true if the Detected Major Java version is 9 or higher, otherwise false.

getNumericValueGetter

public static String getNumericValueGetter(Class type)

getPrimitiveWrapperClass

public static Class getPrimitiveWrapperClass(Class primitiveClass)

getNumericCast

public static String getNumericCast(Class type)

getNumericLiteral

public static String getNumericLiteral(Class type)

setCompiler

public static void setCompiler(OgnlExpressionCompiler compiler)

getCompiler

public static OgnlExpressionCompiler getCompiler()

compileExpression

public static void compileExpression(OgnlContext context,
                     Node expression,
                     Object root)
                              throws Exception

Throws:: Exception

getTargetClass
```
public static Class getTargetClass(Object o)
```
Gets the "target" class of an object for looking up accessors that are registered on the target. If the object is a Class object this will return the Class itself, else it will return object's getClass() result.

Parameters:
o - the Object from which to retrieve its Class.

Returns:
the Class of o.

getBaseName
```
public static String getBaseName(Object o)
```
Returns the base name (the class name without the package name prepended) of the object given.

Parameters:
o - the Object from which to retrieve its base classname.

Returns:
the base classname of o's Class.

getClassBaseName
```
public static String getClassBaseName(Class c)
```
Returns the base name (the class name without the package name prepended) of the class given.

Parameters:
c - the Class from which to retrieve its name.

Returns:
the base classname of c.

getClassName

public static String getClassName(Object o,
                  boolean fullyQualified)

getClassName

public static String getClassName(Class c,
                  boolean fullyQualified)

getPackageName
```
public static String getPackageName(Object o)
```
Returns the package name of the object's class.

Parameters:
o - the Object from which to retrieve its Class package name.

Returns:
the package name of o's Class.

getClassPackageName
```
public static String getClassPackageName(Class c)
```
Returns the package name of the class given.

Parameters:
c - the Class from which to retrieve its package name.

Returns:
the package name of c.

getPointerString
```
public static String getPointerString(int num)
```
Returns a "pointer" string in the usual format for these things - 0x<hex digits>.

Parameters:
num - the int to convert into a "pointer" string in hex format.

Returns:
the String representing num as a "pointer" string in hex format.

getPointerString
```
public static String getPointerString(Object o)
```
Returns a "pointer" string in the usual format for these things - 0x<hex digits> for the object given. This will always return a unique value for each object.

Parameters:
o - the Object to convert into a "pointer" string in hex format.

Returns:
the String representing o as a "pointer" string in hex format.

getUniqueDescriptor
```
public static String getUniqueDescriptor(Object object,
                         boolean fullyQualified)
```
Returns a unique descriptor string that includes the object's class and a unique integer identifier. If fullyQualified is true then the class name will be fully qualified to include the package name, else it will be just the class' base name.

Parameters:
object - the Object for which a unique descriptor string is desired.
fullyQualified - true if the descriptor string is fully-qualified (package name), false for just the Class' base name.

Returns:
the unique descriptor String for the object, qualified as per fullyQualified parameter.

getUniqueDescriptor
```
public static String getUniqueDescriptor(Object object)
```
Returns a unique descriptor string that includes the object's class' base name and a unique integer identifier.

Parameters:
object - the Object for which a unique descriptor string is desired.

Returns:
the unique descriptor String for the object, NOT fully-qualified.

toArray
```
public static Object[] toArray(List list)
```
Utility to convert a List into an Object[] array. If the list is zero elements this will return a constant array; toArray() on List always returns a new object and this is wasteful for our purposes.

Parameters:
list - the List to convert into an Object array.

Returns:
the array of Objects from the list.

getParameterTypes
```
public static Class[] getParameterTypes(Method m)
```
Returns the parameter types of the given method.

Parameters:
m - the Method whose parameter types are being queried.

Returns:
the array of Class elements representing m's parameters. May be null if m does not utilize parameters.

findParameterTypes
```
public static Class[] findParameterTypes(Class type,
                         Method m)
```
Finds the appropriate parameter types for the given Method and Class instance of the type the method is associated with. Correctly finds generic types if running in >= 1.5 jre as well.

Parameters:
type - The class type the method is being executed against.
m - The method to find types for.

Returns:
Array of parameter types for the given method.

getParameterTypes
```
public static Class[] getParameterTypes(Constructor c)
```
Returns the parameter types of the given method.

Parameters:
c - the Constructor whose parameter types are being queried.

Returns:
the array of Class elements representing c's parameters. May be null if c does not utilize parameters.

getSecurityManager
```
public static SecurityManager getSecurityManager()
```
Gets the SecurityManager that OGNL uses to determine permissions for invoking methods.

Returns:
SecurityManager for OGNL

setSecurityManager
```
public static void setSecurityManager(SecurityManager value)
```
Sets the SecurityManager that OGNL uses to determine permissions for invoking methods.

Parameters:
value - SecurityManager to set

getPermission
```
public static Permission getPermission(Method method)
```
Permission will be named "invoke.<declaring-class>.<method-name>".

Parameters:
method - the Method whose Permission is being requested.

Returns:
the Permission for method named "invoke.<declaring-class>.<method-name>".

invokeMethod

public static Object invokeMethod(Object target,
                  Method method,
                  Object[] argsArray)
                           throws InvocationTargetException,
                                  IllegalAccessException

Throws:: InvocationTargetException; IllegalAccessException

getArgClass
```
public static final Class getArgClass(Object arg)
```
Gets the class for a method argument that is appropriate for looking up methods by reflection, by looking for the standard primitive wrapper classes and exchanging for them their underlying primitive class objects. Other classes are passed through unchanged.

Parameters:
arg - an object that is being passed to a method

Returns:
the class to use to look up the method

getArgClasses

public static Class[] getArgClasses(Object[] args)

isTypeCompatible
```
public static final boolean isTypeCompatible(Object object,
                       Class c)
```
Tells whether the given object is compatible with the given class ---that is, whether the given object can be passed as an argument to a method or constructor whose parameter type is the given class. If object is null this will return true because null is compatible with any type.

Parameters:
object - the Object to check for type-compatibility with Class c.
c - the Class for which object's type-compatibility is being checked.

Returns:
true if object is type-compatible with c.

isTypeCompatible

public static final boolean isTypeCompatible(Class parameterClass,
                       Class methodArgumentClass,
                       int index,
                       OgnlRuntime.ArgsCompatbilityReport report)

areArgsCompatible

public static boolean areArgsCompatible(Object[] args,
                        Class[] classes)

areArgsCompatible

public static OgnlRuntime.ArgsCompatbilityReport areArgsCompatible(Class[] args,
                                                   Class[] classes,
                                                   Method m)

isMoreSpecific
```
public static final boolean isMoreSpecific(Class[] classes1,
                     Class[] classes2)
```
Tells whether the first array of classes is more specific than the second. Assumes that the two arrays are of the same length.

Parameters:
classes1 - the Class array being checked to see if it is "more specific" than classes2.
classes2 - the Class array that classes1 is being checked against to see if classes1 is "more specific" than classes2.

Returns:
true if the classes1 Class contents are "more specific" than classes2 Class contents, false otherwise.

getModifierString

public static String getModifierString(int modifiers)

classForName

public static Class classForName(OgnlContext context,
                 String className)
                          throws ClassNotFoundException

Throws:: ClassNotFoundException

isInstance

public static boolean isInstance(OgnlContext context,
                 Object value,
                 String className)
                          throws OgnlException

Throws:: OgnlException

getPrimitiveDefaultValue

public static Object getPrimitiveDefaultValue(Class forClass)

getNumericDefaultValue

public static Object getNumericDefaultValue(Class forClass)

getConvertedType

public static Object getConvertedType(OgnlContext context,
                      Object target,
                      Member member,
                      String propertyName,
                      Object value,
                      Class type)

getConvertedTypes

public static boolean getConvertedTypes(OgnlContext context,
                        Object target,
                        Member member,
                        String propertyName,
                        Class[] parameterTypes,
                        Object[] args,
                        Object[] newArgs)

getConvertedConstructorAndArgs

public static Constructor getConvertedConstructorAndArgs(OgnlContext context,
                                         Object target,
                                         List constructors,
                                         Object[] args,
                                         Object[] newArgs)

getAppropriateMethod
```
public static Method getAppropriateMethod(OgnlContext context,
                          Object source,
                          Object target,
                          String propertyName,
                          String methodName,
                          List methods,
                          Object[] args,
                          Object[] actualArgs)
```
Gets the appropriate method to be called for the given target, method name and arguments. If successful this method will return the Method within the target that can be called and the converted arguments in actualArgs. If unsuccessful this method will return null and the actualArgs will be empty.

Parameters:
context - The current execution context.
source - Target object to run against or method name.
target - Instance of object to be run against.
propertyName - Name of property to get method of.
methodName - Name of the method to get from known methods.
methods - List of current known methods.
args - Arguments originally passed in.
actualArgs - Converted arguments.

Returns:
Best method match or null if none could be found.

getConvertedMethodAndArgs

public static Method getConvertedMethodAndArgs(OgnlContext context,
                               Object target,
                               String propertyName,
                               List methods,
                               Object[] args,
                               Object[] newArgs)

callAppropriateMethod

public static Object callAppropriateMethod(OgnlContext context,
                           Object source,
                           Object target,
                           String methodName,
                           String propertyName,
                           List methods,
                           Object[] args)
                                    throws MethodFailedException

Throws:: MethodFailedException

callStaticMethod

public static Object callStaticMethod(OgnlContext context,
                      String className,
                      String methodName,
                      Object[] args)
                               throws OgnlException

Throws:: OgnlException

callMethod
```
public static Object callMethod(OgnlContext context,
                Object target,
                String methodName,
                String propertyName,
                Object[] args)
                         throws OgnlException
```
Deprecated. Use callMethod(OgnlContext, Object, String, Object[]) instead.

Invokes the specified method against the target object.

Parameters:
context - The current execution context.
target - The object to invoke the method on.
methodName - Name of the method - as in "getValue" or "add", etc..
propertyName - Name of the property to call instead?
args - Optional arguments needed for method.

Returns:
Result of invoking method.

Throws:

OgnlException - For lots of different reasons.

callMethod
```
public static Object callMethod(OgnlContext context,
                Object target,
                String methodName,
                Object[] args)
                         throws OgnlException
```
Invokes the specified method against the target object.

Parameters:
context - The current execution context.
target - The object to invoke the method on.
methodName - Name of the method - as in "getValue" or "add", etc..
args - Optional arguments needed for method.

Returns:
Result of invoking method.

Throws:

OgnlException - For lots of different reasons.

callConstructor

public static Object callConstructor(OgnlContext context,
                     String className,
                     Object[] args)
                              throws OgnlException

Throws:: OgnlException

getMethodValue

@Deprecated
public static final Object getMethodValue(OgnlContext context,
                               Object target,
                               String propertyName)
                                   throws OgnlException,
                                          IllegalAccessException,
                                          NoSuchMethodException,
                                          IntrospectionException

Deprecated.

Don't use this method as it doesn't check member access rights via MemberAccess interface

Parameters:: context - the current execution context.; target - the object to invoke the property name get on.; propertyName - the name of the property to be retrieved from target.
Returns:: the result invoking property retrieval of propertyName for target.
Throws:: OgnlException - for lots of different reasons.; IllegalAccessException - if access not permitted.; NoSuchMethodException - if no property accessor exists.; IntrospectionException - on errors using Introspector.

getMethodValue
```
public static final Object getMethodValue(OgnlContext context,
                    Object target,
                    String propertyName,
                    boolean checkAccessAndExistence)
                                   throws OgnlException,
                                          IllegalAccessException,
                                          NoSuchMethodException,
                                          IntrospectionException
```
If the checkAccessAndExistence flag is true this method will check to see if the method exists and if it is accessible according to the context's MemberAccess. If neither test passes this will return NotFound.

Parameters:
context - the current execution context.
target - the object to invoke the property name get on.
propertyName - the name of the property to be retrieved from target.
checkAccessAndExistence - true if this method should check access levels and existence for propertyName of target, false otherwise.

Returns:
the result invoking property retrieval of propertyName for target.

Throws:

OgnlException - for lots of different reasons.

IllegalAccessException - if access not permitted.

NoSuchMethodException - if no property accessor exists.

IntrospectionException - on errors using Introspector.

setMethodValue

@Deprecated
public static boolean setMethodValue(OgnlContext context,
                                Object target,
                                String propertyName,
                                Object value)
                              throws OgnlException,
                                     IllegalAccessException,
                                     NoSuchMethodException,
                                     IntrospectionException

Deprecated.

Don't use this method as it doesn't check member access rights via MemberAccess interface

Parameters:: context - the current execution context.; target - the object to invoke the property name get on.; propertyName - the name of the property to be set for target.; value - the value to set for propertyName of target.
Returns:: true if the operation succeeded, false otherwise.
Throws:: OgnlException - for lots of different reasons.; IllegalAccessException - if access not permitted.; NoSuchMethodException - if no property accessor exists.; IntrospectionException - on errors using Introspector.

setMethodValue

public static boolean setMethodValue(OgnlContext context,
                     Object target,
                     String propertyName,
                     Object value,
                     boolean checkAccessAndExistence)
                              throws OgnlException,
                                     IllegalAccessException,
                                     NoSuchMethodException,
                                     IntrospectionException

Throws:: OgnlException; IllegalAccessException; NoSuchMethodException; IntrospectionException

getConstructors

public static List getConstructors(Class targetClass)

getMethods

public static Map getMethods(Class targetClass,
             boolean staticMethods)

getAllMethods

public static Map getAllMethods(Class targetClass,
                boolean staticMethods)

getMethods

public static List getMethods(Class targetClass,
              String name,
              boolean staticMethods)

getAllMethods

public static List getAllMethods(Class targetClass,
                 String name,
                 boolean staticMethods)

getFields

public static Map getFields(Class targetClass)

getField

public static Field getField(Class inClass,
             String name)

getFieldValue
```
@Deprecated
public static Object getFieldValue(OgnlContext context,
                              Object target,
                              String propertyName)
                            throws NoSuchFieldException
```
Deprecated.

Don't use this method as it doesn't check member access rights via MemberAccess interface

Parameters:
context - the current execution context.
target - the object to invoke the property name get on.
propertyName - the name of the property to be set for target.

Returns:
the result invoking field retrieval of propertyName for target.

Throws:

NoSuchFieldException - if the field does not exist.

getFieldValue

public static Object getFieldValue(OgnlContext context,
                   Object target,
                   String propertyName,
                   boolean checkAccessAndExistence)
                            throws NoSuchFieldException

Throws:: NoSuchFieldException

setFieldValue

public static boolean setFieldValue(OgnlContext context,
                    Object target,
                    String propertyName,
                    Object value)
                             throws OgnlException

Throws:: OgnlException

isFieldAccessible

public static boolean isFieldAccessible(OgnlContext context,
                        Object target,
                        Class inClass,
                        String propertyName)

isFieldAccessible

public static boolean isFieldAccessible(OgnlContext context,
                        Object target,
                        Field field,
                        String propertyName)

hasField

public static boolean hasField(OgnlContext context,
               Object target,
               Class inClass,
               String propertyName)

getStaticField
```
public static Object getStaticField(OgnlContext context,
                    String className,
                    String fieldName)
                             throws OgnlException
```
Method name is getStaticField(), but actually behaves more like "getStaticFieldValue()".
Typical usage: Returns the value (not the actual Field) for the given (static) fieldName. May return the Enum constant value for the given fieldName when className is an Enum. May return a Class instance when the given fieldName is "class".

Parameters:
context - The current ognl context
className - The name of the class which contains the field
fieldName - The name of the field whose value should be returned

Returns:
The value of the (static) fieldName

Throws:

OgnlException - for lots of different reasons.

getDeclaredMethods

public static List getDeclaredMethods(Class targetClass,
                      String propertyName,
                      boolean findSets)

getGetMethod
```
public static Method getGetMethod(OgnlContext context,
                  Class targetClass,
                  String propertyName)
                           throws IntrospectionException,
                                  OgnlException
```
cache get methods

Parameters:
context - the current execution context.
targetClass - the Class to invoke the property name "getter" retrieval on.
propertyName - the name of the property for which a "getter" is sought.

Returns:
the Method representing a "getter" for propertyName of targetClass.

Throws:

OgnlException - for lots of different reasons.

IntrospectionException - on errors using Introspector.

isMethodAccessible

public static boolean isMethodAccessible(OgnlContext context,
                         Object target,
                         Method method,
                         String propertyName)

hasGetMethod

public static boolean hasGetMethod(OgnlContext context,
                   Object target,
                   Class targetClass,
                   String propertyName)
                            throws IntrospectionException,
                                   OgnlException

Throws:: IntrospectionException; OgnlException

getSetMethod
```
public static Method getSetMethod(OgnlContext context,
                  Class targetClass,
                  String propertyName)
                           throws IntrospectionException,
                                  OgnlException
```
cache set methods method

Parameters:
context - the current execution context.
targetClass - the Class to invoke the property name "setter" retrieval on.
propertyName - the name of the property for which a "setter" is sought.

Returns:
the Method representing a "setter" for propertyName of targetClass.

Throws:

IntrospectionException - on errors using Introspector.

OgnlException - for lots of different reasons.

hasSetMethod

public static final boolean hasSetMethod(OgnlContext context,
                   Object target,
                   Class targetClass,
                   String propertyName)
                                  throws IntrospectionException,
                                         OgnlException

Throws:: IntrospectionException; OgnlException

hasGetProperty

public static final boolean hasGetProperty(OgnlContext context,
                     Object target,
                     Object oname)
                                    throws IntrospectionException,
                                           OgnlException

Throws:: IntrospectionException; OgnlException

hasSetProperty

public static final boolean hasSetProperty(OgnlContext context,
                     Object target,
                     Object oname)
                                    throws IntrospectionException,
                                           OgnlException

Throws:: IntrospectionException; OgnlException

getPropertyDescriptors
```
public static Map getPropertyDescriptors(Class targetClass)
                                  throws IntrospectionException,
                                         OgnlException
```
This method returns the property descriptors for the given class as a Map.

Parameters:
targetClass - The class to get the descriptors for.

Returns:
Map map of property descriptors for class.

Throws:

IntrospectionException - on errors using Introspector.

OgnlException - On general errors.

getPropertyDescriptor
```
public static PropertyDescriptor getPropertyDescriptor(Class targetClass,
                                       String propertyName)
                                                throws IntrospectionException,
                                                       OgnlException
```
This method returns a PropertyDescriptor for the given class and property name using a Map lookup (using getPropertyDescriptorsMap()).

Parameters:
targetClass - the class to get the descriptors for.
propertyName - the property name of targetClass for which a Descriptor is requested.

Returns:
the PropertyDescriptor for propertyName of targetClass.

Throws:

IntrospectionException - on errors using Introspector.

OgnlException - On general errors.

getPropertyDescriptorsArray

public static PropertyDescriptor[] getPropertyDescriptorsArray(Class targetClass)
                                                        throws IntrospectionException

Throws:: IntrospectionException

getPropertyDescriptorFromArray
```
public static PropertyDescriptor getPropertyDescriptorFromArray(Class targetClass,
                                                String name)
                                                         throws IntrospectionException
```
Gets the property descriptor with the given name for the target class given.

Parameters:
targetClass - Class for which property descriptor is desired
name - Name of property

Returns:
PropertyDescriptor of the named property or null if the class has no property with the given name

Throws:

IntrospectionException - on errors using Introspector.

setMethodAccessor

public static void setMethodAccessor(Class cls,
                     MethodAccessor accessor)

getMethodAccessor

public static MethodAccessor getMethodAccessor(Class cls)
                                        throws OgnlException

Throws:: OgnlException

setPropertyAccessor

public static void setPropertyAccessor(Class cls,
                       PropertyAccessor accessor)

getPropertyAccessor

public static PropertyAccessor getPropertyAccessor(Class cls)
                                            throws OgnlException

Throws:: OgnlException

getElementsAccessor

public static ElementsAccessor getElementsAccessor(Class cls)
                                            throws OgnlException

Throws:: OgnlException

setElementsAccessor

public static void setElementsAccessor(Class cls,
                       ElementsAccessor accessor)

getNullHandler

public static NullHandler getNullHandler(Class cls)
                                  throws OgnlException

Throws:: OgnlException

setNullHandler

public static void setNullHandler(Class cls,
                  NullHandler handler)

getProperty

public static Object getProperty(OgnlContext context,
                 Object source,
                 Object name)
                          throws OgnlException

Throws:: OgnlException

setProperty

public static void setProperty(OgnlContext context,
               Object target,
               Object name,
               Object value)
                        throws OgnlException

Throws:: OgnlException

getIndexedPropertyType
```
public static int getIndexedPropertyType(OgnlContext context,
                         Class sourceClass,
                         String name)
                                  throws OgnlException
```
Determines the index property type, if any. Returns INDEXED_PROPERTY_NONE if the property is not index-accessible as determined by OGNL or JavaBeans. If it is indexable then this will return whether it is a JavaBeans indexed property, conforming to the indexed property patterns (returns INDEXED_PROPERTY_INT) or if it conforms to the OGNL arbitrary object indexable (returns INDEXED_PROPERTY_OBJECT).

Parameters:
context - the current execution context.
sourceClass - the Class to invoke indexed property type retrieval on.
name - the name of the property for which an indexed property type is sought.

Returns:
the indexed property type (int) for the property name of sourceClass. Returns INDEXED_PROPERTY_NONE if name is not an indexed property.

Throws:

OgnlException - for lots of different reasons.

getIndexedProperty

public static Object getIndexedProperty(OgnlContext context,
                        Object source,
                        String name,
                        Object index)
                                 throws OgnlException

Throws:: OgnlException

setIndexedProperty

public static void setIndexedProperty(OgnlContext context,
                      Object source,
                      String name,
                      Object index,
                      Object value)
                               throws OgnlException

Throws:: OgnlException

getEvaluationPool

public static EvaluationPool getEvaluationPool()

getObjectArrayPool

public static ObjectArrayPool getObjectArrayPool()

setClassCacheInspector
```
public static void setClassCacheInspector(ClassCacheInspector inspector)
```
Registers the specified ClassCacheInspector with all class reflection based internal caches. This may have a significant performance impact so be careful using this in production scenarios.

Parameters:
inspector - The inspector instance that will be registered with all internal cache instances.

getMethod

public static Method getMethod(OgnlContext context,
               Class target,
               String name,
               Node[] children,
               boolean includeStatic)
                        throws Exception

Throws:: Exception

getReadMethod
```
public static Method getReadMethod(Class target,
                   String name)
```
Finds the best possible match for a method on the specified target class with a matching name.
The name matched will also try different combinations like is + name, has + name, get + name, etc..

Parameters:
target - The class to find a matching method against.
name - The name of the method.

Returns:
The most likely matching Method, or null if none could be found.

getReadMethod

public static Method getReadMethod(Class target,
                   String name,
                   Class[] argClasses)

getWriteMethod

public static Method getWriteMethod(Class target,
                    String name)

getWriteMethod

public static Method getWriteMethod(Class target,
                    String name,
                    Class[] argClasses)

getProperty

public static PropertyDescriptor getProperty(Class target,
                             String name)

isBoolean

public static boolean isBoolean(String expression)

shouldConvertNumericTypes
```
public static boolean shouldConvertNumericTypes(OgnlContext context)
```
Compares the OgnlContext.getCurrentType() and OgnlContext.getPreviousType() class types on the stack to determine if a numeric expression should force object conversion.
Normally used in conjunction with the forceConversion parameter of getChildSource(OgnlContext,Object,Node,boolean).

Parameters:
context - The current context.

Returns:
True, if the class types on the stack wouldn't be comparable in a pure numeric expression such as o1 >= o2.

getChildSource
```
public static String getChildSource(OgnlContext context,
                    Object target,
                    Node child)
                             throws OgnlException
```
Attempts to get the java source string represented by the specific child expression via the JavaSource.toGetSourceString(OgnlContext,Object) interface method.

Parameters:
context - The ognl context to pass to the child.
target - The current object target to use.
child - The child expression.

Returns:
The result of calling JavaSource.toGetSourceString(OgnlContext,Object) plus additional enclosures of OgnlOps.convertValue(Object,Class,boolean) for conversions.

Throws:

OgnlException - Mandatory exception throwing catching.. (blehh)

getChildSource
```
public static String getChildSource(OgnlContext context,
                    Object target,
                    Node child,
                    boolean forceConversion)
                             throws OgnlException
```
Attempts to get the java source string represented by the specific child expression via the JavaSource.toGetSourceString(OgnlContext,Object) interface method.

Parameters:
context - The ognl context to pass to the child.
target - The current object target to use.
child - The child expression.
forceConversion - If true, forces OgnlOps.convertValue(Object,Class) conversions on the objects.

Returns:
The result of calling JavaSource.toGetSourceString(OgnlContext,Object) plus additional enclosures of OgnlOps.convertValue(Object,Class,boolean) for conversions.

Throws:

OgnlException - Mandatory exception throwing catching.. (blehh)

getUseJDK9PlusAccessHandlerValue
```
public static boolean getUseJDK9PlusAccessHandlerValue()
```
Returns the value of the flag indicating whether the JDK9+ access handler has been been requested (it can then be used if the Major Java Version number is 9+). Note: Value is controlled by a Java option flag USE_JDK9PLUS_ACESS_HANDLER.

Returns:
true if a request to use the JDK9+ access handler is requested, false otherwise (always use pre-JDK9 handler).
Since:

3.1.25

getUseStricterInvocationValue
```
public static boolean getUseStricterInvocationValue()
```
Returns the value of the flag indicating whether "stricter" invocation is in effect or not. Note: Value is controlled by a Java option flag USE_STRICTER_INVOCATION.

Returns:
true if stricter invocation is in effect, false otherwise.
Since:

3.1.25

getDisableOgnlSecurityManagerOnInitValue
```
public static boolean getDisableOgnlSecurityManagerOnInitValue()
```
Returns the value of the flag indicating whether the OGNL SecurityManager was disabled on initialization or not. Note: Value is controlled by a Java option flag OGNL_SECURITY_MANAGER using the value OGNL_SM_FORCE_DISABLE_ON_INIT.

Returns:
true if OGNL SecurityManager was disabled on initialization, false otherwise.
Since:

3.1.25

usingJDK9PlusAccessHandler
```
public static boolean usingJDK9PlusAccessHandler()
```
Returns an indication as to whether the current state indicates the JDK9+ (9 and later) access handler is being used / should be used. This is based on a combination of the detected Major Java Version and the Java option flag USE_JDK9PLUS_ACESS_HANDLER.

Returns:
true if the JDK9 and later access handler is being used / should be used, false otherwise.
Since:

3.1.25

getUseFirstMatchGetSetLookupValue
```
public static boolean getUseFirstMatchGetSetLookupValue()
```
Returns the value of the flag indicating whether the old "first match" lookup for getters/setters is in effect or not. Note: Value is controlled by a Java option flag USE_FIRSTMATCH_GETSET_LOOKUP.

Returns:
true if the old "first match" lookup is in effect, false otherwise.
Since:

3.1.25

Class OgnlRuntime

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NotFound

NotFoundList

NotFoundMap

NoArguments

NoArgumentTypes

NoConversionPossible

INDEXED_PROPERTY_NONE

INDEXED_PROPERTY_INT

INDEXED_PROPERTY_OBJECT

NULL_STRING

NoArgsReport

Constructor Detail

OgnlRuntime

Method Detail

clearCache

clearAdditionalCache

getMajorJavaVersion

isJdk9Plus

getNumericValueGetter

getPrimitiveWrapperClass

getNumericCast

getNumericLiteral

setCompiler

getCompiler

compileExpression

getTargetClass

getBaseName

getClassBaseName

getClassName

getClassName

getPackageName

getClassPackageName

getPointerString

getPointerString

getUniqueDescriptor

getUniqueDescriptor

toArray

getParameterTypes

findParameterTypes

getParameterTypes

getSecurityManager

setSecurityManager

getPermission

invokeMethod

getArgClass

getArgClasses

isTypeCompatible

isTypeCompatible

areArgsCompatible

areArgsCompatible

isMoreSpecific

getModifierString

classForName

isInstance

getPrimitiveDefaultValue

getNumericDefaultValue

getConvertedType

getConvertedTypes

getConvertedConstructorAndArgs

getAppropriateMethod

getConvertedMethodAndArgs

callAppropriateMethod

callStaticMethod

callMethod

callMethod

callConstructor

getMethodValue

getMethodValue

setMethodValue

setMethodValue

getConstructors

getMethods

getAllMethods