Class PropertyIterator

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: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
Author:
Dmitri Plotnikov

  • Field Details

    • empty

      private boolean empty

    • reverse

      private boolean reverse

    • name

      private String name

    • startIndex

      private int startIndex

    • targetReady

      private boolean targetReady

    • position

      private int position

    • propertyNodePointer

      private PropertyPointer propertyNodePointer

    • startPropertyIndex

      private int startPropertyIndex

    • includeStart

      private boolean includeStart

  • Constructor Details

    • 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 Details

    • 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.

    • setPositionIndividualProperty

      private boolean setPositionIndividualProperty(int position)
      Set position for an individual property.
      Parameters:
      position - int position
      Returns:
      whether this was a valid position

    • setPositionAllProperties

      private boolean setPositionAllProperties(int position)
      Set position for all properties
      Parameters:
      position - int position
      Returns:
      whether this was a valid position

    • prepareForIndividualProperty

      protected void prepareForIndividualProperty(String name)
      Prepare for an individual property.
      Parameters:
      name - property name

    • getLength

      private int getLength()
      Computes length for the current pointer - ignores any exceptions.
      Returns:
      length