net.markenwerk.commons.iterables

Class StringTokenizerIterable

java.lang.Object

net.markenwerk.commons.iterables.StringTokenizerIterable

All Implemented Interfaces:

Iterable<String>, ProtectedIterable<String>

public final class StringTokenizerIterable
extends Object
implements ProtectedIterable<String>

A StringTokenizerIterable is a ProtectedIterable that can be wrapped around a given Producer for StringTokenizers and generates Iterators that yield all strings from a produced StringTokenizer.

Since:

1.1.6

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
StringTokenizerIterable(net.markenwerk.commons.interfaces.Provider<StringTokenizer> producer) Creates a new StringTokenizerIterable.

Method Summary

Modifier and Type	Method and Description
net.markenwerk.commons.iterators.StringTokenizerIterator	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

StringTokenizerIterable

public StringTokenizerIterable(net.markenwerk.commons.interfaces.Provider<StringTokenizer> producer)
                        throws IllegalArgumentException

Creates a new StringTokenizerIterable.

Parameters:

producer - The Producer for StringTokenizers to iterate over.

Throws:

IllegalArgumentException - If the given Producer for StringTokenizers is null.

Method Detail

iterator

public net.markenwerk.commons.iterators.StringTokenizerIterator iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface ProtectedIterable<String>

Returns:

A ProtectedIterator.