Top Description Methods
org.apache.commons.jexl2.introspection

public Interface JexlPropertyGet

Known Direct Implementers
org.apache.commons.jexl2.introspection.UberspectImpl.IndexedType, org.apache.commons.jexl2.introspection.UberspectImpl.FieldPropertyGet, org.apache.commons.jexl2.internal.AbstractExecutor.Get

Interface for getting values that appear to be properties. Ex. ${foo.bar}
Since
1.0

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

the property value.
invoke
(Object
the object to get the property value from.
obj
)

Method used to get the property value of an object.

public boolean

Returns:

true if can be reused for this class, false if not
isCacheable
()

Specifies if this JexlPropertyGet is cacheable and able to be reused for this class of object it was returned for.

public boolean

Returns:

true if tryInvoke failed, false otherwise
tryFailed
(Object
the value returned by tryInvoke
rval
)

Checks whether a tryInvoke failed or not.

public Object

Returns:

the result of the method invocation that should be checked by tryFailed to determine if it succeeded or failed.
tryInvoke
(Object
the object to invoke the property get upon
obj
,
Object
the property key to get
key
)

Attempts to reuse this JexlPropertyGet, checking that it is compatible with the actual set of arguments.

Method Detail

invokeback to summary
public Object invoke(Object obj) throws Exception

Method used to get the property value of an object.

Parameters
obj:Object

the object to get the property value from.

Returns:Object

the property value.

Exceptions
Exception:
on any error.
isCacheableback to summary
public boolean isCacheable()

Specifies if this JexlPropertyGet is cacheable and able to be reused for this class of object it was returned for.

Returns:boolean

true if can be reused for this class, false if not

tryFailedback to summary
public boolean tryFailed(Object rval)

Checks whether a tryInvoke failed or not.

Parameters
rval:Object

the value returned by tryInvoke

Returns:boolean

true if tryInvoke failed, false otherwise

tryInvokeback to summary
public Object tryInvoke(Object obj, Object key)

Attempts to reuse this JexlPropertyGet, checking that it is compatible with the actual set of arguments.

Parameters
obj:Object

the object to invoke the property get upon

key:Object

the property key to get

Returns:Object

the result of the method invocation that should be checked by tryFailed to determine if it succeeded or failed.