Package | Description |
---|---|
org.apache.commons.ognl |
OGNL stands for Object-Graph Navigation Language; it is an expression language
for getting and setting properties of Java objects.
|
Modifier and Type | Class and Description |
---|---|
class |
ExpressionSyntaxException
Exception thrown if a malformed OGNL expression is encountered.
|
class |
InappropriateExpressionException
Exception thrown if an OGNL expression is evaluated in the wrong context; the usual
case is when an expression that does not end in a property reference is passed to
setValue . |
class |
MethodFailedException
Exception thrown if a method or constructor call fails.
|
class |
NoSuchPropertyException
Exception thrown if a property is attempted to be extracted from an object that does
not have such a property.
|
Modifier and Type | Method and Description |
---|---|
static Object |
OgnlRuntime.callConstructor(OgnlContext context,
String className,
Object[] args) |
static Object |
OgnlRuntime.callMethod(OgnlContext context,
Object target,
String methodName,
Object[] args)
Invokes the specified method against the target object.
|
static Object |
OgnlRuntime.callMethod(OgnlContext context,
Object target,
String methodName,
String propertyName,
Object[] args)
Deprecated.
|
static Object |
OgnlRuntime.callStaticMethod(OgnlContext context,
String className,
String methodName,
Object[] args) |
protected Object |
SimpleNode.evaluateGetValueBody(OgnlContext context,
Object source) |
protected void |
SimpleNode.evaluateSetValueBody(OgnlContext context,
Object target,
Object value) |
static String |
OgnlRuntime.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 |
OgnlRuntime.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. |
Enumeration |
ElementsAccessor.getElements(Object target)
Returns an iterator over the elements of the given target object.
|
static ElementsAccessor |
OgnlRuntime.getElementsAccessor(Class cls) |
static Method |
OgnlRuntime.getGetMethod(OgnlContext context,
Class targetClass,
String propertyName) |
static Object |
OgnlRuntime.getIndexedProperty(OgnlContext context,
Object source,
String name,
Object index) |
static int |
OgnlRuntime.getIndexedPropertyType(OgnlContext context,
Class sourceClass,
String name)
Determines the index property type, if any.
|
int |
ASTProperty.getIndexedPropertyType(OgnlContext context,
Object source)
Returns true if this property is described by an IndexedPropertyDescriptor and that if
followed by an index specifier it will call the index get/set methods rather than go through
property accessors.
|
static MethodAccessor |
OgnlRuntime.getMethodAccessor(Class cls) |
static Object |
OgnlRuntime.getMethodValue(OgnlContext context,
Object target,
String propertyName) |
static Object |
OgnlRuntime.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 NullHandler |
OgnlRuntime.getNullHandler(Class cls) |
Object |
ObjectPropertyAccessor.getPossibleProperty(Map context,
Object target,
String name)
Returns OgnlRuntime.NotFound if the property does not exist.
|
Object |
EnumerationPropertyAccessor.getProperty(Map context,
Object target,
Object name) |
Object |
ListPropertyAccessor.getProperty(Map context,
Object target,
Object name) |
Object |
ArrayPropertyAccessor.getProperty(Map context,
Object target,
Object name) |
Object |
MapPropertyAccessor.getProperty(Map context,
Object target,
Object name) |
Object |
SetPropertyAccessor.getProperty(Map context,
Object target,
Object name) |
Object |
ObjectPropertyAccessor.getProperty(Map context,
Object target,
Object oname) |
Object |
PropertyAccessor.getProperty(Map context,
Object target,
Object name)
Extracts and returns the property of the given name from the given target object.
|
Object |
IteratorPropertyAccessor.getProperty(Map context,
Object target,
Object name) |
Object |
ASTProperty.getProperty(OgnlContext context,
Object source) |
static Object |
OgnlRuntime.getProperty(OgnlContext context,
Object source,
Object name) |
static PropertyAccessor |
OgnlRuntime.getPropertyAccessor(Class cls) |
static PropertyDescriptor |
OgnlRuntime.getPropertyDescriptor(Class targetClass,
String propertyName)
This method returns a PropertyDescriptor for the given class and property name using a Map
lookup (using getPropertyDescriptorsMap()).
|
static Map |
OgnlRuntime.getPropertyDescriptors(Class targetClass)
This method returns the property descriptors for the given class as a Map.
|
static Method |
OgnlRuntime.getSetMethod(OgnlContext context,
Class targetClass,
String propertyName) |
static Object |
OgnlRuntime.getStaticField(OgnlContext context,
String className,
String fieldName) |
static Object |
Ognl.getValue(Object tree,
Map context,
Object root)
Evaluates the given OGNL expression tree to extract a value from the given root object.
|
static Object |
Ognl.getValue(Object tree,
Map context,
Object root,
Class resultType)
Evaluates the given OGNL expression tree to extract a value from the given root object.
|
static Object |
Ognl.getValue(Object tree,
Object root)
Evaluates the given OGNL expression tree to extract a value from the given root object.
|
static Object |
Ognl.getValue(Object tree,
Object root,
Class resultType)
Evaluates the given OGNL expression tree to extract a value from the given root object.
|
Object |
SimpleNode.getValue(OgnlContext context,
Object source) |
Object |
Node.getValue(OgnlContext context,
Object source)
Extracts the value from the given source object that is appropriate for this node
within the given context.
|
static Object |
Ognl.getValue(String expression,
Map context,
Object root)
Evaluates the given OGNL expression to extract a value from the given root object in a given
context
|
static Object |
Ognl.getValue(String expression,
Map context,
Object root,
Class resultType)
Evaluates the given OGNL expression to extract a value from the given root object in a given
context
|
static Object |
Ognl.getValue(String expression,
Object root)
Convenience method that combines calls to
parseExpression and
getValue . |
static Object |
Ognl.getValue(String expression,
Object root,
Class resultType)
Convenience method that combines calls to
parseExpression and
getValue . |
protected Object |
ASTThisVarRef.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTConst.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTSequence.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTProperty.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTList.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTInstanceof.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTAnd.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTOr.getValueBody(OgnlContext context,
Object source) |
protected abstract Object |
SimpleNode.getValueBody(OgnlContext context,
Object source)
Subclasses implement this method to do the actual work of extracting the appropriate value from the source object.
|
protected Object |
ASTVarRef.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTRootVarRef.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTMethod.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTCtor.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTStaticField.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTChain.getValueBody(OgnlContext context,
Object source) |
protected Object |
ASTStaticMethod.getValueBody(OgnlContext context,
Object source) |
static boolean |
OgnlRuntime.hasGetMethod(OgnlContext context,
Object target,
Class targetClass,
String propertyName) |
boolean |
ObjectPropertyAccessor.hasGetProperty(Map context,
Object target,
Object oname) |
boolean |
ObjectPropertyAccessor.hasGetProperty(OgnlContext context,
Object target,
Object oname) |
static boolean |
OgnlRuntime.hasGetProperty(OgnlContext context,
Object target,
Object oname) |
static boolean |
OgnlRuntime.hasSetMethod(OgnlContext context,
Object target,
Class targetClass,
String propertyName) |
boolean |
ObjectPropertyAccessor.hasSetProperty(Map context,
Object target,
Object oname) |
boolean |
ObjectPropertyAccessor.hasSetProperty(OgnlContext context,
Object target,
Object oname) |
static boolean |
OgnlRuntime.hasSetProperty(OgnlContext context,
Object target,
Object oname) |
static boolean |
OgnlOps.in(Object v1,
Object v2) |
static boolean |
Ognl.isConstant(Object tree)
Same as
Ognl.isConstant(Object, java.util.Map) - only the Map context
is created for you. |
static boolean |
Ognl.isConstant(Object tree,
Map context)
Checks if the specified
Node instance represents a constant
expression. |
boolean |
ExpressionNode.isConstant(OgnlContext context) |
boolean |
SimpleNode.isConstant(OgnlContext context) |
static boolean |
Ognl.isConstant(String expression)
Same as
Ognl.isConstant(String, java.util.Map) - only the Map
instance is created for you. |
static boolean |
Ognl.isConstant(String expression,
Map context)
Checks if the specified expression represents a constant expression.
|
static boolean |
OgnlRuntime.isInstance(OgnlContext context,
Object value,
String className) |
boolean |
ASTConst.isNodeConstant(OgnlContext context) |
boolean |
ExpressionNode.isNodeConstant(OgnlContext context)
Returns true iff this node is constant without respect to the children.
|
boolean |
SimpleNode.isNodeConstant(OgnlContext context)
Returns true iff this node is constant without respect to the children.
|
boolean |
ASTStaticField.isNodeConstant(OgnlContext context) |
boolean |
ASTProperty.isNodeSimpleProperty(OgnlContext context) |
boolean |
SimpleNode.isNodeSimpleProperty(OgnlContext context) |
static boolean |
Ognl.isSimpleNavigationChain(Object tree) |
static boolean |
Ognl.isSimpleNavigationChain(Object tree,
Map context) |
boolean |
SimpleNode.isSimpleNavigationChain(OgnlContext context) |
boolean |
ASTChain.isSimpleNavigationChain(OgnlContext context) |
static boolean |
Ognl.isSimpleNavigationChain(String expression) |
static boolean |
Ognl.isSimpleNavigationChain(String expression,
Map context) |
static boolean |
Ognl.isSimpleProperty(Object tree) |
static boolean |
Ognl.isSimpleProperty(Object tree,
Map context) |
boolean |
SimpleNode.isSimpleProperty(OgnlContext context) |
static boolean |
Ognl.isSimpleProperty(String expression) |
static boolean |
Ognl.isSimpleProperty(String expression,
Map context) |
static Object |
Ognl.parseExpression(String expression)
Parses the given OGNL expression and returns a tree representation of the expression that can
be used by
Ognl static methods. |
static boolean |
OgnlRuntime.setFieldValue(OgnlContext context,
Object target,
String propertyName,
Object value) |
static void |
OgnlRuntime.setIndexedProperty(OgnlContext context,
Object source,
String name,
Object index,
Object value) |
static boolean |
OgnlRuntime.setMethodValue(OgnlContext context,
Object target,
String propertyName,
Object value) |
static boolean |
OgnlRuntime.setMethodValue(OgnlContext context,
Object target,
String propertyName,
Object value,
boolean checkAccessAndExistence) |
Object |
ObjectPropertyAccessor.setPossibleProperty(Map context,
Object target,
String name,
Object value)
Returns OgnlRuntime.NotFound if the property does not exist.
|
void |
EnumerationPropertyAccessor.setProperty(Map context,
Object target,
Object name,
Object value) |
void |
ListPropertyAccessor.setProperty(Map context,
Object target,
Object name,
Object value) |
void |
ArrayPropertyAccessor.setProperty(Map context,
Object target,
Object name,
Object value) |
void |
MapPropertyAccessor.setProperty(Map context,
Object target,
Object name,
Object value) |
void |
ObjectPropertyAccessor.setProperty(Map context,
Object target,
Object oname,
Object value) |
void |
PropertyAccessor.setProperty(Map context,
Object target,
Object name,
Object value)
Sets the value of the property of the given name in the given target object.
|
void |
IteratorPropertyAccessor.setProperty(Map context,
Object target,
Object name,
Object value) |
static void |
OgnlRuntime.setProperty(OgnlContext context,
Object target,
Object name,
Object value) |
static void |
Ognl.setValue(Object tree,
Map context,
Object root,
Object value)
Evaluates the given OGNL expression tree to insert a value into the object graph rooted at
the given root object.
|
static void |
Ognl.setValue(Object tree,
Object root,
Object value)
Evaluates the given OGNL expression tree to insert a value into the object graph rooted at
the given root object.
|
void |
SimpleNode.setValue(OgnlContext context,
Object target,
Object value) |
void |
Node.setValue(OgnlContext context,
Object target,
Object value)
Sets the given value in the given target as appropriate for this node within the
given context.
|
static void |
Ognl.setValue(String expression,
Map context,
Object root,
Object value)
Evaluates the given OGNL expression to insert a value into the object graph rooted at the
given root object given the context.
|
static void |
Ognl.setValue(String expression,
Object root,
Object value)
Convenience method that combines calls to
parseExpression and
setValue . |
protected void |
ASTThisVarRef.setValueBody(OgnlContext context,
Object target,
Object value) |
protected void |
ASTSequence.setValueBody(OgnlContext context,
Object target,
Object value) |
protected void |
ASTProperty.setValueBody(OgnlContext context,
Object target,
Object value) |
protected void |
ASTAnd.setValueBody(OgnlContext context,
Object target,
Object value) |
protected void |
ASTOr.setValueBody(OgnlContext context,
Object target,
Object value) |
protected void |
SimpleNode.setValueBody(OgnlContext context,
Object target,
Object value)
Subclasses implement this method to do the actual work of setting the appropriate value in the target object.
|
protected void |
ASTVarRef.setValueBody(OgnlContext context,
Object target,
Object value) |
protected void |
ASTRootVarRef.setValueBody(OgnlContext context,
Object target,
Object value) |
protected void |
ASTChain.setValueBody(OgnlContext context,
Object target,
Object value) |
Copyright © 1997–2021 The Apache Software Foundation. All rights reserved.