org.apache.commons.jxpath

Interface DynamicPropertyHandler

All Known Implementing Classes:

HttpSessionHandler, MapDynamicPropertyHandler, PageContextHandler, PageScopeContextHandler, ServletContextHandler, ServletRequestHandler

public interface DynamicPropertyHandler

A generic mechanism for accessing collections of name/value pairs. Examples of such collections are HashMap, Properties, ServletContext. In order to add support for a new such collection type to JXPath, perform the following two steps:

1. Build an implementation of the DynamicPropertyHandler interface for the desired collection type.
2. Invoke the static method JXPathIntrospector.registerDynamicClass(class, handlerClass)

JXPath allows access to dynamic properties using these three formats:

• "myMap/myKey"
• "myMap[@name = 'myKey']"
• "myMap[name(.) = 'myKey']"

Version:

$Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getProperty(java.lang.Object object, java.lang.String propertyName) Returns the value of the specified dynamic property.
java.lang.String[]	getPropertyNames(java.lang.Object object) Returns a list of dynamic property names for the supplied object.
void	setProperty(java.lang.Object object, java.lang.String propertyName, java.lang.Object value) Modifies the value of the specified dynamic property.

Method Detail

getPropertyNames

java.lang.String[] getPropertyNames(java.lang.Object object)

Returns a list of dynamic property names for the supplied object.

Parameters:

object - to inspect

Returns:

String[]

getProperty

java.lang.Object getProperty(java.lang.Object object,
                             java.lang.String propertyName)

Returns the value of the specified dynamic property.

Parameters:

object - to search

propertyName - to retrieve

Returns:

Object

setProperty

void setProperty(java.lang.Object object,
                 java.lang.String propertyName,
                 java.lang.Object value)

Modifies the value of the specified dynamic property.

Parameters:

object - to modify

propertyName - to modify

value - to set