ArrayCharListIterator (Joda-Primitives 1.1-SNAPSHOT API)

java.lang.Object
- org.joda.primitives.listiterator.impl.ArrayCharListIterator

All Implemented Interfaces:

java.util.Iterator<java.lang.Character>, java.util.ListIterator<java.lang.Character>, CharIterator, PrimitiveIterator<java.lang.Character>, CharListIterator, PrimitiveListIterator<java.lang.Character>
```
public class ArrayCharListIterator
extends java.lang.Object
implements CharListIterator
```
An iterator over an array of char values.
This class implements ListIterator allowing seamless integration with other APIs.
The iterator can be reset to the start if required. add() and remove() are unsupported, but set() is supported.

Since:

1.0

Version:

CODE GENERATED

Field Summary

Fields
Modifier and Type Field and Description

protected char[] array
The array to iterate over

protected int cursor
Cursor position

protected int last
Last returned position

Fields
Modifier and Type	Field and Description
`protected char[]`	`array` The array to iterate over
`protected int`	`cursor` Cursor position
`protected int`	`last` Last returned position

Constructor Summary

Constructors
Constructor and Description

ArrayCharListIterator(char[] array)
Constructs an iterator over an array of char values.

Constructors
Constructor and Description
`ArrayCharListIterator(char[] array)` Constructs an iterator over an array of `char` values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(char value)` Adds the specified value to the list underlying the iterator at the current iteration index (optional operation).
`void`	`add(java.lang.Character value)`
`static ArrayCharListIterator`	`copyOf(char[] array)` Creates an iterator over a copy of an array of `char` values.
`boolean`	`hasNext()`
`boolean`	`hasPrevious()`
`boolean`	`isModifiable()` Checks whether the iterator can currently be modified.
`boolean`	`isResettable()` Checks whether the iterator can be reset.
`java.lang.Character`	`next()`
`char`	`nextChar()` Gets the next value from the iterator
`int`	`nextIndex()`
`java.lang.Character`	`previous()`
`char`	`previousChar()` Gets the previous value from the iterator.
`int`	`previousIndex()`
`void`	`remove()`
`void`	`reset()` Resets the iterator back to its initial state (optional operation).
`void`	`set(char value)` Sets the last retrieved value from the iterator (optional operation).
`void`	`set(java.lang.Character value)`

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
  - array
```
protected final char[] array
```
    The array to iterate over
  - cursor
```
protected int cursor
```
    Cursor position
  - last
```
protected int last
```
    Last returned position
- Constructor Detail
  - ArrayCharListIterator
```
public ArrayCharListIterator(char[] array)
```
    Constructs an iterator over an array of char values.
    The array is assigned internally, thus the caller holds a reference to the internal state of the returned iterator. It is not recommended to modify the state of the array after construction.
    
    Parameters:
    
    array - the array to iterate over, must not be null
    
    Throws:
    
    java.lang.IllegalArgumentException - if the array is null
- Method Detail
  - copyOf
```
public static ArrayCharListIterator copyOf(char[] array)
```
    Creates an iterator over a copy of an array of char values.
    The specified array is copied, ensuring the original data is unaltered. Note that the class is not immutable due to the set methods.
    
    Parameters:
    
    array - the array to iterate over, must not be null
    
    Returns:
    
    an iterator based on a copy of the input array, not null
    
    Throws:
    
    java.lang.IllegalArgumentException - if the array is null
  - isModifiable
```
public boolean isModifiable()
```
    Description copied from interface: PrimitiveIterator
    
    Checks whether the iterator can currently be modified.
    
    Specified by:
    
    isModifiable in interface PrimitiveIterator<java.lang.Character>
    
    Returns:
    
    true if the modification methods of the iterator can be used
  - isResettable
```
public boolean isResettable()
```
    Description copied from interface: PrimitiveIterator
    
    Checks whether the iterator can be reset.
    
    Specified by:
    
    isResettable in interface PrimitiveIterator<java.lang.Character>
    
    Returns:
    
    true if the object can be reset
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface java.util.Iterator<java.lang.Character>
    
    Specified by:
    
    hasNext in interface java.util.ListIterator<java.lang.Character>
  - nextIndex
```
public int nextIndex()
```
    Specified by:
    
    nextIndex in interface java.util.ListIterator<java.lang.Character>
  - nextChar
```
public char nextChar()
```
    Description copied from interface: CharIterator
    
    Gets the next value from the iterator
    
    Specified by:
    
    nextChar in interface CharIterator
    
    Returns:
    
    the next available value
  - next
```
public java.lang.Character next()
```
    Specified by:
    
    next in interface java.util.Iterator<java.lang.Character>
    
    Specified by:
    
    next in interface java.util.ListIterator<java.lang.Character>
  - hasPrevious
```
public boolean hasPrevious()
```
    Specified by:
    
    hasPrevious in interface java.util.ListIterator<java.lang.Character>
  - previousIndex
```
public int previousIndex()
```
    Specified by:
    
    previousIndex in interface java.util.ListIterator<java.lang.Character>
  - previousChar
```
public char previousChar()
```
    Description copied from interface: CharListIterator
    
    Gets the previous value from the iterator.
    
    Specified by:
    
    previousChar in interface CharListIterator
    
    Returns:
    
    the previous available value
  - previous
```
public java.lang.Character previous()
```
    Specified by:
    
    previous in interface java.util.ListIterator<java.lang.Character>
  - add
```
public void add(char value)
```
    Description copied from interface: CharListIterator
    
    Adds the specified value to the list underlying the iterator at the current iteration index (optional operation).
    
    Specified by:
    
    add in interface CharListIterator
    
    Parameters:
    
    value - the value to add
  - add
```
public void add(java.lang.Character value)
```
    Specified by:
    
    add in interface java.util.ListIterator<java.lang.Character>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface java.util.Iterator<java.lang.Character>
    
    Specified by:
    
    remove in interface java.util.ListIterator<java.lang.Character>
  - set
```
public void set(char value)
```
    Description copied from interface: CharListIterator
    
    Sets the last retrieved value from the iterator (optional operation).
    
    Specified by:
    
    set in interface CharListIterator
    
    Parameters:
    
    value - the value to set
  - set
```
public void set(java.lang.Character value)
```
    Specified by:
    
    set in interface java.util.ListIterator<java.lang.Character>
  - reset
```
public void reset()
```
    Description copied from interface: PrimitiveIterator
    
    Resets the iterator back to its initial state (optional operation).
    
    Specified by:
    
    reset in interface PrimitiveIterator<java.lang.Character>

Class ArrayCharListIterator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Field Detail

array

cursor

last

Constructor Detail

ArrayCharListIterator

Method Detail

copyOf

isModifiable

isResettable

hasNext

nextIndex

nextChar

next

hasPrevious

previousIndex

previousChar

previous

add

add

remove

set

set

reset