JexlPropertySet (Commons JEXL 2.0.1 API)
Keywords: org.apache.commons.jexl2.introspection.JexlPropertySet interface

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.jexl2.introspection
Interface JexlPropertySet

All Known Implementing Classes:
  AbstractExecutor.Set, DuckSetExecutor, ListSetExecutor, MapSetExecutor, PropertySetExecutor, UberspectImpl.FieldPropertySet

    public interface JexlPropertySet

Interface used for setting values that appear to be properties. Ex. `${foo.bar = "hello"}`

Since:
  1.0
Version:
  $Id: JexlPropertySet.java 889760 2009-12-11 18:42:49Z sebb $
Author:
  Geir Magnusson Jr.

Method Summary
`java.lang.Object` | `invoke(java.lang.Object obj, java.lang.Object arg)` Method used to set the property value of an object.
`boolean` | `isCacheable()` Specifies if this JexlPropertySet is cacheable and able to be reused for this class of object it was returned for.
`boolean` | `tryFailed(java.lang.Object rval)` Checks whether a tryInvoke failed or not.
`java.lang.Object` | `tryInvoke(java.lang.Object obj, java.lang.Object key, java.lang.Object value)` Attempts to reuse this JexlPropertySet, checking that it is compatible with the actual set of arguments.

Method Detail

### invoke

    java.lang.Object invoke(java.lang.Object obj,
                            java.lang.Object arg)
                            throws java.lang.Exception

  Method used to set the property value of an object.

  Parameters:
    `obj` - Object on which the property setter will be called with the value
    `arg` - value to be set
  Returns:
    the value returned from the set operation (impl specific)
  Throws:
    `java.lang.Exception` - on any error.

### tryInvoke

    java.lang.Object tryInvoke(java.lang.Object obj,
                               java.lang.Object key,
                               java.lang.Object value)

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

  Parameters:
    `obj` - the object to invoke the the get upon
    `key` - the property key to get
    `value` - the property value to set
  Returns:
    the result of the method invocation that should be checked by tryFailed to determine if it succeeded or failed.

### tryFailed

    boolean tryFailed(java.lang.Object rval)

  Checks whether a tryInvoke failed or not.

  Parameters:
    `rval` - the value returned by tryInvoke
  Returns:
    true if tryInvoke failed, false otherwise

### isCacheable

    boolean isCacheable()

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

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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.