info.bioinfweb.commons.collections

Class NumberedStringsIterator

java.lang.Object

info.bioinfweb.commons.collections.NumberedStringsIterator

All Implemented Interfaces:

java.util.Iterator<java.lang.String>

public class NumberedStringsIterator
extends java.lang.Object
implements java.util.Iterator<java.lang.String>

Implementation of Iterator that returns strings with defined prefix followed by an integer from a specified range.

This tool class is e.g. helpful for implementing data adapters in JPhyloIO or alignment models in LibrAlign that use numbered IDs.

The example applications of JPhyloIO demonstrate the usage of this class.

Since:

2.0.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
NumberedStringsIterator(java.lang.String prefix, long count) Creates a new instance of this class starting with the index 0.
NumberedStringsIterator(java.lang.String prefix, long startIndex, long count) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
static int	extractIntIndexFromString(java.lang.String string, java.lang.String prefix) Extracts an index from a numbered string.
static long	extractLongIndexFromString(java.lang.String string, java.lang.String prefix) Extracts an index from a numbered string.
boolean	hasNext()
java.lang.String	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

NumberedStringsIterator

public NumberedStringsIterator(java.lang.String prefix,
                               long startIndex,
                               long count)

Creates a new instance of this class.

Parameters:

prefix - the prefix all returned IDs (strings) shall have

startIndex - the index of the first ID (string) to be returned

count - the number of elements to be returned by this iterator

NumberedStringsIterator

public NumberedStringsIterator(java.lang.String prefix,
                               long count)

Creates a new instance of this class starting with the index 0.

Parameters:

prefix - the prefix all returned strings shall have

count - the number of elements to be returned by this iterator

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<java.lang.String>

next

public java.lang.String next()

Specified by:

next in interface java.util.Iterator<java.lang.String>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<java.lang.String>

extractLongIndexFromString

public static long extractLongIndexFromString(java.lang.String string,
                                              java.lang.String prefix)

Extracts an index from a numbered string. (Strings are assumed to start with a common prefix followed by an integer index.)

Parameters:

string - the string containing the index

prefix - the prefix strings are expected to contain before the index

Returns:

the extracted index

Throws:

java.lang.IllegalArgumentException - if no index could be extracted from the specified string

extractIntIndexFromString

public static int extractIntIndexFromString(java.lang.String string,
                                            java.lang.String prefix)

Extracts an index from a numbered string. (Strings are assumed to start with a common prefix followed by an integer index.)

Parameters:

string - the string containing the index

prefix - the prefix strings are expected to contain before the index

Returns:

the extracted index

Throws:

java.lang.IllegalArgumentException - if no index could be extracted from the specified string