net.markenwerk.commons.iterables

Class ShortArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.ShortArrayIterable

All Implemented Interfaces:

Iterable<Short>, BidirectionalIterable<Short>, ProtectedBidirectionalIterable<Short>

public final class ShortArrayIterable
extends Object
implements ProtectedBidirectionalIterable<Short>

A ShortArrayIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given short[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ShortArrayIterable(short... array) Creates a new ShortArrayIterable.

Method Summary

Modifier and Type	Method and Description
ShortArrayIterator	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

ShortArrayIterable

public ShortArrayIterable(short... array)
                   throws IllegalArgumentException

Creates a new ShortArrayIterable.

Parameters:

array - The short[] to iterate over.

Throws:

IllegalArgumentException - If the given short[] is null.

Method Detail

iterator

public ShortArrayIterator iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Short>

Specified by:

iterator in interface BidirectionalIterable<Short>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Short>

Returns:

A ProtectedIterator.