Summary: Fields | Methods | Protected Methods | Inherited Methods | [Expand All]

public class

ResultSetIterator

extends Object
implements Iterator DynaBean

java.lang.Object
↳	org.apache.commons.beanutils.ResultSetIterator

Class Overview

Implementation of java.util.Iterator returned by the iterator() method of ResultSetDynaClass. Each object returned by this iterator will be a DynaBean that represents a single row from the result set being wrapped.

Summary

Fields
protected boolean	current	Flag indicating whether the result set is currently positioned at a row for which we have not yet returned an element in the iteration.
protected ResultSetDynaClass	dynaClass	The `ResultSetDynaClass` we are associated with.
protected boolean	eof	Flag indicating whether the result set has indicated that there are no further rows.

Public Methods
boolean	contains(String name, String key) Does the specified mapped property contain a value for the specified key value?
Object	get(String name, int index) Return the value of an indexed property with the specified name.
Object	get(String name, String key) Return the value of a mapped property with the specified name, or `null` if there is no value for the specified key.
Object	get(String name) Return the value of a simple property with the specified name.
DynaClass	getDynaClass() Return the `DynaClass` instance that describes the set of properties available for this DynaBean.
boolean	hasNext() Return `true` if the iteration has more elements.
Object	next() Return the next element in the iteration.
void	remove() Remove the current element from the iteration.
void	remove(String name, String key) Remove any existing value for the specified key on the specified mapped property.
void	set(String name, int index, Object value) Set the value of an indexed property with the specified name.
void	set(String name, String key, Object value) Set the value of a mapped property with the specified name.
void	set(String name, Object value) Set the value of a simple property with the specified name.

Protected Methods
void	advance() Advance the result set to the next row, if there is not a current row (and if we are not already at eof).

[Expand]

Inherited Methods

From class java.lang.Object

From interface java.util.Iterator

From interface org.apache.commons.beanutils.DynaBean

abstract boolean	contains(String name, String key) Does the specified mapped property contain a value for the specified key value?
abstract Object	get(String name) Return the value of a simple property with the specified name.
abstract Object	get(String name, int index) Return the value of an indexed property with the specified name.
abstract Object	get(String name, String key) Return the value of a mapped property with the specified name, or `null` if there is no value for the specified key.
abstract DynaClass	getDynaClass() Return the `DynaClass` instance that describes the set of properties available for this DynaBean.
abstract void	remove(String name, String key) Remove any existing value for the specified key on the specified mapped property.
abstract void	set(String name, String key, Object value) Set the value of a mapped property with the specified name.
abstract void	set(String name, int index, Object value) Set the value of an indexed property with the specified name.
abstract void	set(String name, Object value) Set the value of a simple property with the specified name.

Fields

protected boolean current

Flag indicating whether the result set is currently positioned at a row for which we have not yet returned an element in the iteration.

protected ResultSetDynaClass dynaClass

The ResultSetDynaClass we are associated with.

protected boolean eof

Flag indicating whether the result set has indicated that there are no further rows.

Public Methods

public boolean contains (String name, String key)

Does the specified mapped property contain a value for the specified key value?

Parameters

name	Name of the property to check
key	Name of the key to check

Returns

true if the mapped property contains a value for the specified key, otherwise false


  
      Throws
        
        
            IllegalArgumentException
            if there is no property
  of the specified name






 
    
      
        public 
         
         
         
         
        Object
      
      get
      (String name, int index)
    
      
        


        
  

      
    
      
  Return the value of an indexed property with the specified name.
  
      Parameters
      
        
          name
          Name of the property whose value is to be retrieved
        
        
          index
          Index of the value to be retrieved
        
      
  
  
      Returns
      The indexed property's value
  
  
      Throws
        
        
            IllegalArgumentException
            if there is no property
  of the specified name
          
        
            IllegalArgumentException
            if the specified property
  exists, but is not indexed
          
        
            IndexOutOfBoundsException
            if the specified index
  is outside the range of the underlying property
          
        
            NullPointerException
            if no array or List has been
  initialized for this property

        
      
  

    





 
    
      
        public 
         
         
         
         
        Object
      
      get
      (String name, String key)
    
      
        


        
  

      
    
      
  Return the value of a mapped property with the specified name,
 or null if there is no value for the specified key.
  
      Parameters
      
        
          name
          Name of the property whose value is to be retrieved
        
        
          key
          Key of the value to be retrieved
        
      
  
  
      Returns
      The mapped property's value
  
  
      Throws
        
        
            IllegalArgumentException
            if there is no property
  of the specified name
          
        
            IllegalArgumentException
            if the specified property
  exists, but is not mapped

        
      
  

    





 
    
      
        public 
         
         
         
         
        Object
      
      get
      (String name)
    
      
        


        
  

      
    
      
  Return the value of a simple property with the specified name.
  
      Parameters
      
        
          name
          Name of the property whose value is to be retrieved
        
      
  
  
      Returns
      The property's value
  
  
      Throws
        
        
            IllegalArgumentException
            if there is no property
  of the specified name

        
      
  

    





 
    
      
        public 
         
         
         
         
        DynaClass
      
      getDynaClass
      ()
    
      
        


        
  

      
    
      
  Return the DynaClass instance that describes the set of
 properties available for this DynaBean.
  
      Returns
      The associated DynaClass

  

    





 
    
      
        public 
         
         
         
         
        boolean
      
      hasNext
      ()
    
      
        


        
  

      
    
      
  
Return true if the iteration has more elements.

  
      Returns
      true if the result set has another
 row, otherwise false

  

    





 
    
      
        public 
         
         
         
         
        Object
      
      next
      ()
    
      
        


        
  

      
    
      
  
Return the next element in the iteration.

  
      Returns
      advance to the new row and return this

  

    





 
    
      
        public 
         
         
         
         
        void
      
      remove
      ()
    
      
        


        
  

      
    
      
  
Remove the current element from the iteration.  This method is
 not supported.


    





 
    
      
        public 
         
         
         
         
        void
      
      remove
      (String name, String key)
    
      
        


        
  

      
    
      
  Remove any existing value for the specified key on the
 specified mapped property.
  
      Parameters
      
        
          name
          Name of the property for which a value is to
  be removed
        
        
          key
          Key of the value to be removed
        
      
  
  
      Throws
        
        
            IllegalArgumentException
            if there is no property
  of the specified name

        
      
  

    





 
    
      
        public 
         
         
         
         
        void
      
      set
      (String name, int index, Object value)
    
      
        


        
  

      
    
      
  Set the value of an indexed property with the specified name.
  
      Parameters
      
        
          name
          Name of the property whose value is to be set
        
        
          index
          Index of the property to be set
        
        
          value
          Value to which this property is to be set
        
      
  
  
      Throws
        
        
            ConversionException
            if the specified value cannot be
  converted to the type required for this property
          
        
            IllegalArgumentException
            if there is no property
  of the specified name
          
        
            IllegalArgumentException
            if the specified property
  exists, but is not indexed
          
        
            IndexOutOfBoundsException
            if the specified index
  is outside the range of the underlying property

        
      
  

    





 
    
      
        public 
         
         
         
         
        void
      
      set
      (String name, String key, Object value)
    
      
        


        
  

      
    
      
  Set the value of a mapped property with the specified name.
  
      Parameters
      
        
          name
          Name of the property whose value is to be set
        
        
          key
          Key of the property to be set
        
        
          value
          Value to which this property is to be set
        
      
  
  
      Throws
        
        
            ConversionException
            if the specified value cannot be
  converted to the type required for this property
          
        
            IllegalArgumentException
            if there is no property
  of the specified name
          
        
            IllegalArgumentException
            if the specified property
  exists, but is not mapped

        
      
  

    





 
    
      
        public 
         
         
         
         
        void
      
      set
      (String name, Object value)
    
      
        


        
  

      
    
      
  Set the value of a simple property with the specified name.
  
      Parameters
      
        
          name
          Name of the property whose value is to be set
        
        
          value
          Value to which this property is to be set
        
      
  
  
      Throws
        
        
            ConversionException
            if the specified value cannot be
  converted to the type required for this property
          
        
            IllegalArgumentException
            if there is no property
  of the specified name
          
        
            NullPointerException
            if an attempt is made to set a
  primitive property to null

        
      
  

    








Protected Methods





 
    
      
        protected 
         
         
         
         
        void
      
      advance
      ()
    
      
        


        
  

      
    
      
  
Advance the result set to the next row, if there is not a current
 row (and if we are not already at eof).

  
      Throws
        
        
            SQLException
            if the result set throws an exception

        
      
  

    










Generated by Doclava.

name	Name of the property whose value is to be retrieved
index	Index of the value to be retrieved

IllegalArgumentException	if there is no property of the specified name
IllegalArgumentException	if the specified property exists, but is not indexed
IndexOutOfBoundsException	if the specified index is outside the range of the underlying property
NullPointerException	if no array or List has been initialized for this property

name	Name of the property whose value is to be retrieved
key	Key of the value to be retrieved

name	Name of the property for which a value is to be removed
key	Key of the value to be removed

ConversionException	if the specified value cannot be converted to the type required for this property
IllegalArgumentException	if there is no property of the specified name
IllegalArgumentException	if the specified property exists, but is not indexed
IndexOutOfBoundsException	if the specified index is outside the range of the underlying property

name	Name of the property whose value is to be set
key	Key of the property to be set
value	Value to which this property is to be set

Interfaces

Classes

Exceptions

ResultSetIterator

Class Overview

Summary

Fields

protected boolean current

protected ResultSetDynaClass dynaClass

protected boolean eof

Public Methods

public boolean contains (String name, String key)

Parameters

Returns

Throws

public Object get (String name, int index)

Parameters

Returns

Throws

public Object get (String name, String key)

Parameters

Returns

Throws

public Object get (String name)

Parameters

Returns

Throws

public DynaClass getDynaClass ()

Returns

public boolean hasNext ()

Returns

public Object next ()

Returns

public void remove ()

public void remove (String name, String key)

Parameters

Throws

public void set (String name, int index, Object value)

Parameters

Throws

public void set (String name, String key, Object value)

Parameters

Throws

public void set (String name, Object value)

Parameters

Throws

Protected Methods

protected void advance ()

Throws