Top Description Constructors Methods
org.apache.commons.lang3.util

public Class IterableStringTokenizer

extends StringTokenizer
implements Iterable<String>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Imports
java.util.ArrayList, .Iterator, .List, .Objects, .StringTokenizer, java.util.stream.Stream, .StreamSupport, org.apache.commons.lang3.ArrayUtils

A StringTokenizer that implements Iterable<String> and conversion methods toList() and toStream().
Since
3.18.0

Constructor Summary

AccessConstructor and Description
public
IterableStringTokenizer(final String
a string to be parsed.
str
)

Constructs a new instance like StringTokenizer#StringTokenizer(String, String, boolean).

public
IterableStringTokenizer(final String
a string to be parsed.
str
,
final String
the delimiters.
delim
)

Constructs a new instance like StringTokenizer#StringTokenizer(String, String, boolean).

public
IterableStringTokenizer(final String
a string to be parsed.
str
,
final String
the delimiters.
delim
,
final boolean
flag indicating whether to return the delimiters as tokens.
returnDelims
)

Constructs a new instance like StringTokenizer#StringTokenizer(String, String, boolean).

Method Summary

Modifier and TypeMethod and Description
public Iterator<String>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

public String[]

Returns:

a new String[].
toArray
()

Returns a new String[] containing the tokenizer elements.

public List<String>

Returns:

a new List.
toList
()

Returns a new List containing the tokenizer elements.

public Stream<String>

Returns:

a sequential stream on this Iterable instance.
toStream
()

Returns a sequential stream on this Iterable instance.

Inherited from java.util.StringTokenizer:
countTokenshasMoreElementshasMoreTokensnextElementnextTokennextToken

Constructor Detail

IterableStringTokenizerback to summary
public IterableStringTokenizer(final String str)

Constructs a new instance like StringTokenizer#StringTokenizer(String, String, boolean).

Parameters
str:String

a string to be parsed.

Exceptions
NullPointerException:
if str is null.
IterableStringTokenizerback to summary
public IterableStringTokenizer(final String str, final String delim)

Constructs a new instance like StringTokenizer#StringTokenizer(String, String, boolean).

Parameters
str:String

a string to be parsed.

delim:String

the delimiters.

Exceptions
NullPointerException:
if str is null.
IterableStringTokenizerback to summary
public IterableStringTokenizer(final String str, final String delim, final boolean returnDelims)

Constructs a new instance like StringTokenizer#StringTokenizer(String, String, boolean).

Parameters
str:String

a string to be parsed.

delim:String

the delimiters.

returnDelims:boolean

flag indicating whether to return the delimiters as tokens.

Exceptions
NullPointerException:
if str is null.

Method Detail

iteratorback to summary
public Iterator<String> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations
@Override
toArrayback to summary
public String[] toArray()

Returns a new String[] containing the tokenizer elements.

Returns:String[]

a new String[].

toListback to summary
public List<String> toList()

Returns a new List containing the tokenizer elements.

Returns:List<String>

a new List.

toStreamback to summary
public Stream<String> toStream()

Returns a sequential stream on this Iterable instance.

Returns:Stream<String>

a sequential stream on this Iterable instance.