haplotype

Class HapsMarkerIterator

java.lang.Object

haplotype.HapsMarkerIterator

All Implemented Interfaces:

FileIt<HapsMarker>, java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<HapsMarker>

public class HapsMarkerIterator
extends java.lang.Object
implements FileIt<HapsMarker>

Class HapsMarkerIterator represents a file iterator whose next() method returns HapsMarker objects.

Instances of class HapsMarkerIterator are not thread-safe.

Constructor Summary

Constructors

Constructor and Description
HapsMarkerIterator(HapPairs haps) Constructs a new HapsMarkerIterator instance that iterates through the markers of the specified HapPairs object.

Method Summary

Modifier and Type	Method and Description
void	close() Terminates the iteration and releases any system resources that are held by this object.
java.io.File	file() Returns the file from which the data are read, or null if the data are read from standard input or are computed data.
boolean	hasNext() Returns true if the iteration has more elements, and returns false otherwise.
HapsMarker	next() Returns the next element in the iteration.
void	remove() The remove method is not supported by this iterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface blbutil.FileIt

toString

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

HapsMarkerIterator

public HapsMarkerIterator(HapPairs haps)

Constructs a new HapsMarkerIterator instance that iterates through the markers of the specified HapPairs object.

Parameters:

haps - the haplotype pairs

Throws:

java.lang.NullPointerException - if haps == null

Method Detail

file

public java.io.File file()

Description copied from interface: FileIt

Returns the file from which the data are read, or null if the data are read from standard input or are computed data.

Specified by:

file in interface FileIt<HapsMarker>

Returns:

the file from which the data are read, or null if the data are read from standard input or are computed data

close

public void close()

Description copied from interface: FileIt

Terminates the iteration and releases any system resources that are held by this object. After invoking close, further invocations of close() have no effect.

Specified by:

close in interface FileIt<HapsMarker>

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

hasNext

public boolean hasNext()

Returns true if the iteration has more elements, and returns false otherwise.

Specified by:

hasNext in interface java.util.Iterator<HapsMarker>

Returns:

true if the iteration has more elements

next

public HapsMarker next()

Returns the next element in the iteration.

Specified by:

next in interface java.util.Iterator<HapsMarker>

Returns:

the next element in the iteration

Throws:

java.util.NoSuchElementException - if the iteration has no more elements

remove

public void remove()

The remove method is not supported by this iterator.

Specified by:

remove in interface java.util.Iterator<HapsMarker>

Throws:

java.lang.UnsupportedOperationException - if this method is invoked