fiftyone.mobile.detection.entities

Class Enumerable

java.lang.Object

fiftyone.mobile.detection.entities.Enumerable

All Implemented Interfaces:

Iterable<Integer>, Iterator<Integer>

public class Enumerable
extends Object
implements Iterator<Integer>, Iterable<Integer>

Class implements the logic of IEnumerable in C#.

When you need to read a specific number of integer objects from the data file it's best to do so on the as-needed basis instead of loading everything in to memory. This class provides a way to read the integers one by one.

Objects of this class should not be created directly as they are part of the internal logic.

For more information see: 51Degrees pattern data model.

Constructor Summary

Constructors

Constructor and Description
Enumerable(BinaryReader reader, int max) An enumerable that can be used to read through the entries.

Method Summary

Modifier and Type	Method and Description
int	getNext() Get the next element.
boolean	hasNext() Returns true if there are more values to read, false otherwise.
Iterator<Integer>	iterator() Returns this object.
Integer	next() Reads the next integer and returns it.
void	remove() Not supported.

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Enumerable

public Enumerable(BinaryReader reader,
                  int max)

An enumerable that can be used to read through the entries.

Parameters:

reader - Reader set to the position at the start of the list.

max - number of elements that can possibly be returned.

Method Detail

getNext

public int getNext()

Get the next element.

Returns:

integer entry.

hasNext

public boolean hasNext()

Returns true if there are more values to read, false otherwise.

Specified by:

hasNext in interface Iterator<Integer>

Returns:

true if there are more values to read, false otherwise.

next

public Integer next()

Reads the next integer and returns it.

Specified by:

next in interface Iterator<Integer>

Returns:

the next integer in a sequence. Null if current greater than max.

remove

public void remove()

Not supported.

Specified by:

remove in interface Iterator<Integer>

iterator

public Iterator<Integer> iterator()

Returns this object.

Specified by:

iterator in interface Iterable<Integer>

Returns:

this object.