net.markenwerk.commons.iterators

Class ByteArrayIterator

java.lang.Object

net.markenwerk.commons.iterators.AbstractProtectedIterator<Payload>

net.markenwerk.commons.iterators.AbstractProtectedBidirectionalIterator<Payload>

net.markenwerk.commons.iterators.AbstractIndexedIterator<Byte>

net.markenwerk.commons.iterators.ByteArrayIterator

All Implemented Interfaces:

Iterator<Byte>, BidirectionalIterator<Byte>, ProtectedBidirectionalIterator<Byte>, ProtectedIterator<Byte>

public final class ByteArrayIterator
extends AbstractIndexedIterator<Byte>

A ByteArrayIterator is an AbstractIndexedIterator that iterates over a given byte[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ByteArrayIterator(byte... array) Creates a new ByteArrayIterator.

Method Summary

Modifier and Type	Method and Description
Byte	get(int index) Returns the payload value at the given index.

Methods inherited from class net.markenwerk.commons.iterators.AbstractIndexedIterator

hasNext, hasPrevious, next, previous

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.markenwerk.commons.iterators.ProtectedBidirectionalIterator

remove

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ByteArrayIterator

public ByteArrayIterator(byte... array)
                  throws IllegalArgumentException

Creates a new ByteArrayIterator.

Parameters:

array - The byte[] to iterate over.

Throws:

IllegalArgumentException - If the given byte[] is null.

Method Detail

get

public Byte get(int index)

Description copied from class: AbstractIndexedIterator

Returns the payload value at the given index.

Specified by:

get in class AbstractIndexedIterator<Byte>

Parameters:

index - The index to be used, which is guaranteed to be non-negative and smaller then the maximum index.

Returns:

The payload value at the given index.