PropertyIterator (Apache Commons JXPath 1.4-SNAPSHOT API)

java.lang.Object
- org.apache.commons.jxpath.ri.model.beans.PropertyIterator

All Implemented Interfaces:

NodeIterator

Direct Known Subclasses:

BeanAttributeIterator, DynamicPropertyIterator
```
public class PropertyIterator
extends Object
implements NodeIterator
```
Iterates property values of an object pointed at with a PropertyOwnerPointer. Examples of such objects are JavaBeans and objects with Dynamic Properties.

Version:

$Revision: 917247 $ $Date: 2010-02-28 19:47:00 +0100 (So, 28 Feb 2010) $

Author:

Dmitri Plotnikov

Constructor Summary

Constructors
Constructor and Description
`PropertyIterator(PropertyOwnerPointer pointer, String name, boolean reverse, NodePointer startWith)` Create a new PropertyIterator.

Method Summary

Methods
Modifier and Type	Method and Description
`NodePointer`	`getNodePointer()` Get the NodePointer at the current position.
`int`	`getPosition()` Get the current iterator position.
`protected NodePointer`	`getPropertyPointer()` Get the property pointer.
`protected void`	`prepareForIndividualProperty(String name)` Prepare for an individual property.
`void`	`reset()` Reset property iteration.
`boolean`	`setPosition(int position)` Set the new current position.

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

- Constructor Detail
  - PropertyIterator
```
public PropertyIterator(PropertyOwnerPointer pointer,
                String name,
                boolean reverse,
                NodePointer startWith)
```
    Create a new PropertyIterator.
    
    Parameters:
    pointer - owning pointer
    name - property name
    reverse - iteration order
    startWith - beginning pointer
- Method Detail
  - getPropertyPointer
```
protected NodePointer getPropertyPointer()
```
    Get the property pointer.
    
    Returns:
    NodePointer
  - reset
```
public void reset()
```
    Reset property iteration.
  - getNodePointer
```
public NodePointer getNodePointer()
```
    Description copied from interface: NodeIterator
    
    Get the NodePointer at the current position.
    
    Specified by:
    
    getNodePointer in interface NodeIterator
    
    Returns:
    NodePointer
  - getPosition
```
public int getPosition()
```
    Description copied from interface: NodeIterator
    
    Get the current iterator position.
    
    Specified by:
    
    getPosition in interface NodeIterator
    
    Returns:
    int position
  - setPosition
```
public boolean setPosition(int position)
```
    Description copied from interface: NodeIterator
    
    Set the new current position.
    
    Specified by:
    
    setPosition in interface NodeIterator
    
    Parameters:
    position - the position to set
    
    Returns:
    true if there is a node at position.
  - prepareForIndividualProperty
```
protected void prepareForIndividualProperty(String name)
```
    Prepare for an individual property.
    
    Parameters:
    name - property name

Class PropertyIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyIterator

Method Detail

getPropertyPointer

reset

getNodePointer

getPosition

setPosition

prepareForIndividualProperty