Package vcf
Class IntervalVcfIt<E extends MarkerContainer>
java.lang.Object
vcf.IntervalVcfIt<E>
- Type Parameters:
E
- the type parameter
- All Implemented Interfaces:
FileIt<E>
,SampleFileIt<E>
,Closeable
,AutoCloseable
,Iterator<E>
public final class IntervalVcfIt<E extends MarkerContainer>
extends Object
implements SampleFileIt<E>
Class IntervalVcfIterator
is a sample file iterator whose
next()
method returns a marker container.
-
Constructor Summary
ConstructorsConstructorDescriptionIntervalVcfIt
(SampleFileIt<E> it, ChromInterval chromInt) Constructs a newIntervalVcfIterator
instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Stops reading data elements and releases any system resources that are held by this object.file()
Returns the file from which the data are read, ornull
if the data are read from standard input or if the data source is unknown.boolean
hasNext()
Returnstrue
if the iteration has more elements.next()
Returns the next element in the iteration.void
remove()
Theremove
method is not supported by this iterator.samples()
Returns the list of samples.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 Details
-
IntervalVcfIt
Constructs a newIntervalVcfIterator
instance.- Parameters:
it
- an iterator whosenext()
method returns a marker containerchromInt
- a chromosome interval- Throws:
NullPointerException
- ifit == null || interval == null
-
-
Method Details
-
file
Description copied from interface:FileIt
Returns the file from which the data are read, ornull
if the data are read from standard input or if the data source is unknown.- Specified by:
file
in interfaceFileIt<E extends MarkerContainer>
- Returns:
- the file from which the data are read, or
null
if the data are read from standard input or if the data source is unknown
-
samples
Description copied from interface:SampleFileIt
Returns the list of samples.- Specified by:
samples
in interfaceSampleFileIt<E extends MarkerContainer>
- Returns:
- the list of samples
-
hasNext
public boolean hasNext()Returnstrue
if the iteration has more elements.- Specified by:
hasNext
in interfaceIterator<E extends MarkerContainer>
- Returns:
true
if the iteration has more elements.
-
next
Returns the next element in the iteration.- Specified by:
next
in interfaceIterator<E extends MarkerContainer>
- Returns:
- the next element in the iteration.
- Throws:
NoSuchElementException
- if the iteration has no more elements.
-
remove
public void remove()Theremove
method is not supported by this iterator.- Specified by:
remove
in interfaceIterator<E extends MarkerContainer>
- Throws:
UnsupportedOperationException
- if this method is invoked
-
close
public void close()Description copied from interface:FileIt
Stops reading data elements and releases any system resources that are held by this object. Buffered data elements may remain accessible via thehasNext()
andnext()
methods after invokingclose()
. After invokingclose()
, further invocations ofclose()
have no effect.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceFileIt<E extends MarkerContainer>
-