MMapBackedIteratorFactory (picard 2.18.2 API)

java.lang.Object
- picard.illumina.parser.readers.MMapBackedIteratorFactory

```
public class MMapBackedIteratorFactory
extends Object
```
MMapBackedIteratorFactory a file reader that takes a header size and a binary file, maps the file to a read-only byte buffer and provides methods to retrieve the header as it's own bytebuffer and create iterators of different data types over the values of file (starting after the end of the header). Values provided by the MMappedBinaryFileReader are read as if they are little endian. Note (read to end): This class IS thread-safe and immutable though the iterator and ByteBuffers it produces are NOT. The values read are assumed to be signed, NO promoting/sign conversion happens in this class.

Constructor Summary

Constructors
Constructor Description

MMapBackedIteratorFactory()

Constructors
Constructor	Description
`MMapBackedIteratorFactory()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static picard.illumina.parser.readers.BinaryFileIterator<ByteBuffer>`	`getByteBufferIterator(int headerSize, int elementSize, File binaryFile)`
`static picard.illumina.parser.readers.BinaryFileIterator<Byte>`	`getByteIterator(int headerSize, File binaryFile)`
`static picard.illumina.parser.readers.BinaryFileIterator<Float>`	`getFloatIterator(int headerSize, File binaryFile)`
`static picard.illumina.parser.readers.BinaryFileIterator<Integer>`	`getIntegerIterator(int headerSize, File binaryFile)`
`static picard.illumina.parser.readers.BinaryFileIterator<Long>`	`getLongIterator(int headerSize, File binaryFile)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MMapBackedIteratorFactory
```
public MMapBackedIteratorFactory()
```

Method Detail

getIntegerIterator

public static picard.illumina.parser.readers.BinaryFileIterator<Integer> getIntegerIterator(int headerSize,
                                                                                            File binaryFile)

getByteIterator

public static picard.illumina.parser.readers.BinaryFileIterator<Byte> getByteIterator(int headerSize,
                                                                                      File binaryFile)

getFloatIterator

public static picard.illumina.parser.readers.BinaryFileIterator<Float> getFloatIterator(int headerSize,
                                                                                        File binaryFile)

getLongIterator

public static picard.illumina.parser.readers.BinaryFileIterator<Long> getLongIterator(int headerSize,
                                                                                      File binaryFile)

getByteBufferIterator

public static picard.illumina.parser.readers.BinaryFileIterator<ByteBuffer> getByteBufferIterator(int headerSize,
                                                                                                  int elementSize,
                                                                                                  File binaryFile)

Class MMapBackedIteratorFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MMapBackedIteratorFactory

Method Detail

getIntegerIterator

getByteIterator

getFloatIterator

getLongIterator

getByteBufferIterator