net.markenwerk.commons.iterables

Class ByteArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.ByteArrayIterable

All Implemented Interfaces:

Iterable<Byte>, BidirectionalIterable<Byte>, ProtectedBidirectionalIterable<Byte>

public final class ByteArrayIterable
extends Object
implements ProtectedBidirectionalIterable<Byte>

A ByteArrayIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given byte[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ByteArrayIterator	iterator() Returns a ProtectedIterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ByteArrayIterable

public ByteArrayIterable(byte... array)
                  throws IllegalArgumentException

Creates a new ByteArrayIterable.

Parameters:

array - The byte[] to iterate over.

Throws:

IllegalArgumentException - If the given byte[] is null.

Method Detail

iterator

public ByteArrayIterator iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Byte>

Specified by:

iterator in interface BidirectionalIterable<Byte>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Byte>

Returns:

A ProtectedIterator.