SparseArrayIterator (jibx-run - JiBX runtime 1.4.2 API)

java.lang.Object
- org.jibx.runtime.impl.SparseArrayIterator

All Implemented Interfaces:

Iterator
```
public class SparseArrayIterator
extends Object
implements Iterator
```
Iterator class for sparse values in an array. This type of iterator can be used for an object array which has references interspersed with nulls.

Version:

1.1

Author:

Dennis M. Sosnoski

Field Summary

Fields
Modifier and Type Field Description

protected Object[] m_array
Array supplying values for iteration.

protected int m_offset
Offset of next iteration value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`advance()`	Advance to next iteration value.
`static Iterator`	`buildIterator(Object[] array)`	Build iterator.
`boolean`	`hasNext()`	Check for iteration element available.
`Object`	`next()`	Get next iteration element.
`void`	`remove()`	Remove element from iteration.

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

Methods inherited from interface java.util.Iterator
forEachRemaining

- Field Detail
  - m_array
```
protected Object[] m_array
```
    Array supplying values for iteration.
  - m_offset
```
protected int m_offset
```
    Offset of next iteration value.
- Method Detail
  - advance
```
protected boolean advance()
```
    Advance to next iteration value. This advances the current position in the array to the next non-null value.
    
    Returns:
    
    true if element available, false if not
  - hasNext
```
public boolean hasNext()
```
    Check for iteration element available.
    
    Specified by:
    
    hasNext in interface Iterator
    
    Returns:
    
    true if element available, false if not
  - next
```
public Object next()
```
    Get next iteration element.
    
    Specified by:
    
    next in interface Iterator
    
    Returns:
    
    next iteration element
    
    Throws:
    
    NoSuchElementException - if past end of iteration
  - remove
```
public void remove()
```
    Remove element from iteration. This optional operation is not supported and always throws an exception.
    
    Specified by:
    
    remove in interface Iterator
    
    Throws:
    
    UnsupportedOperationException - for unsupported operation
  - buildIterator
```
public static Iterator buildIterator(Object[] array)
```
    Build iterator.
    
    Parameters:
    
    array - array containing values to be iterated (may be null)
    
    Returns:
    
    constructed iterator