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>
,java.io.Closeable
,java.lang.AutoCloseable
,java.util.Iterator<E>
public final class IntervalVcfIt<E extends MarkerContainer> extends java.lang.Object implements SampleFileIt<E>
Class
IntervalVcfIterator
is a sample file iterator whosenext()
method returns a marker container.
-
-
Constructor Summary
Constructors Constructor Description IntervalVcfIt(SampleFileIt<E> it, ChromInterval interval)
Constructs a newIntervalVcfIterator
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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, ornull
if the data are read from standard input or are computed data.boolean
hasNext()
Returnstrue
if the iteration has more elements.E
next()
Returns the next element in the iteration.void
remove()
Theremove
method is not supported by this iterator.Samples
samples()
Returns the list of samples.
-
-
-
Constructor Detail
-
IntervalVcfIt
public IntervalVcfIt(SampleFileIt<E> it, ChromInterval interval)
Constructs a newIntervalVcfIterator
instance.- Parameters:
it
- an iterator whosenext()
method returns a marker containerinterval
- a chromosome interval- Throws:
java.lang.NullPointerException
- ifit == null || interval == null
-
-
Method Detail
-
file
public java.io.File 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 are computed data.- 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 are computed data
-
samples
public Samples 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 interfacejava.util.Iterator<E extends MarkerContainer>
- Returns:
true
if the iteration has more elements.
-
next
public E next()
Returns the next element in the iteration.- Specified by:
next
in interfacejava.util.Iterator<E extends MarkerContainer>
- Returns:
- the next element in the iteration.
- Throws:
java.util.NoSuchElementException
- if the iteration has no more elements.
-
remove
public void remove()
Theremove
method is not supported by this iterator.- Specified by:
remove
in interfacejava.util.Iterator<E extends MarkerContainer>
- Throws:
java.lang.UnsupportedOperationException
- if this method is invoked
-
close
public void close()
Description copied from interface:FileIt
Terminates the iteration and releases any system resources that are held by this object. After invokingclose()
, further invocations ofclose()
have no effect.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in interfaceFileIt<E extends MarkerContainer>
-
-