ArrayByteListIterator (Joda-Primitives 1.1-SNAPSHOT API)

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

All Implemented Interfaces:

java.util.Iterator<java.lang.Byte>, java.util.ListIterator<java.lang.Byte>, ByteIterator, PrimitiveIterator<java.lang.Byte>, ByteListIterator, PrimitiveListIterator<java.lang.Byte>
```
public class ArrayByteListIterator
extends java.lang.Object
implements ByteListIterator
```
An iterator over an array of byte 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 byte[] 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 byte[]`	`array` The array to iterate over
`protected int`	`cursor` Cursor position
`protected int`	`last` Last returned position

Constructor Summary

Constructors
Constructor and Description

ArrayByteListIterator(byte[] array)
Constructs an iterator over an array of byte values.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(byte value)` Adds the specified value to the list underlying the iterator at the current iteration index (optional operation).
`void`	`add(java.lang.Byte value)`
`static ArrayByteListIterator`	`copyOf(byte[] array)` Creates an iterator over a copy of an array of `byte` 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.Byte`	`next()`
`byte`	`nextByte()` Gets the next value from the iterator
`int`	`nextIndex()`
`java.lang.Byte`	`previous()`
`byte`	`previousByte()` 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(byte value)` Sets the last retrieved value from the iterator (optional operation).
`void`	`set(java.lang.Byte 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 byte[] array
```
    The array to iterate over
  - cursor
```
protected int cursor
```
    Cursor position
  - last
```
protected int last
```
    Last returned position
- Constructor Detail
  - ArrayByteListIterator
```
public ArrayByteListIterator(byte[] array)
```
    Constructs an iterator over an array of byte 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 ArrayByteListIterator copyOf(byte[] array)
```
    Creates an iterator over a copy of an array of byte 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.Byte>
    
    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.Byte>
    
    Returns:
    
    true if the object can be reset
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface java.util.Iterator<java.lang.Byte>
    
    Specified by:
    
    hasNext in interface java.util.ListIterator<java.lang.Byte>
  - nextIndex
```
public int nextIndex()
```
    Specified by:
    
    nextIndex in interface java.util.ListIterator<java.lang.Byte>
  - nextByte
```
public byte nextByte()
```
    Description copied from interface: ByteIterator
    
    Gets the next value from the iterator
    
    Specified by:
    
    nextByte in interface ByteIterator
    
    Returns:
    
    the next available value
  - next
```
public java.lang.Byte next()
```
    Specified by:
    
    next in interface java.util.Iterator<java.lang.Byte>
    
    Specified by:
    
    next in interface java.util.ListIterator<java.lang.Byte>
  - hasPrevious
```
public boolean hasPrevious()
```
    Specified by:
    
    hasPrevious in interface java.util.ListIterator<java.lang.Byte>
  - previousIndex
```
public int previousIndex()
```
    Specified by:
    
    previousIndex in interface java.util.ListIterator<java.lang.Byte>
  - previousByte
```
public byte previousByte()
```
    Description copied from interface: ByteListIterator
    
    Gets the previous value from the iterator.
    
    Specified by:
    
    previousByte in interface ByteListIterator
    
    Returns:
    
    the previous available value
  - previous
```
public java.lang.Byte previous()
```
    Specified by:
    
    previous in interface java.util.ListIterator<java.lang.Byte>
  - add
```
public void add(byte value)
```
    Description copied from interface: ByteListIterator
    
    Adds the specified value to the list underlying the iterator at the current iteration index (optional operation).
    
    Specified by:
    
    add in interface ByteListIterator
    
    Parameters:
    
    value - the value to add
  - add
```
public void add(java.lang.Byte value)
```
    Specified by:
    
    add in interface java.util.ListIterator<java.lang.Byte>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface java.util.Iterator<java.lang.Byte>
    
    Specified by:
    
    remove in interface java.util.ListIterator<java.lang.Byte>
  - set
```
public void set(byte value)
```
    Description copied from interface: ByteListIterator
    
    Sets the last retrieved value from the iterator (optional operation).
    
    Specified by:
    
    set in interface ByteListIterator
    
    Parameters:
    
    value - the value to set
  - set
```
public void set(java.lang.Byte value)
```
    Specified by:
    
    set in interface java.util.ListIterator<java.lang.Byte>
  - 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.Byte>

Class ArrayByteListIterator

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

ArrayByteListIterator

Method Detail

copyOf

isModifiable

isResettable

hasNext

nextIndex

nextByte

next

hasPrevious

previousIndex

previousByte

previous

add

add

remove

set

set

reset