Package org.apache.maven.index.reader

Class ChunkReader

java.lang.Object

org.apache.maven.index.reader.ChunkReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Map<String,String>>

public class ChunkReader
extends Object
implements Closeable, Iterable<Map<String,String>>

Maven Index published binary chunk reader, it reads raw Maven Indexer records from the transport binary format. Instances of this class MUST BE handled as resources (have them closed once done with them), it is user responsibility to close them, ideally in try-with-resource block.

Since:

5.1.2

Constructor Summary

Constructors

Constructor	Description
ChunkReader(String chunkName, InputStream inputStream)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this reader and it's underlying input.
String	getName()	Returns the chunk name.
Date	getTimestamp()	Returns the index timestamp of last update of the index.
int	getVersion()	Returns index version.
Iterator<Map<String,String>>	iterator()	Returns the Record iterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ChunkReader

public ChunkReader(String chunkName,
 InputStream inputStream)
            throws IOException

Throws:

IOException

Method Details

getName

public String getName()

Returns the chunk name.

getVersion

public int getVersion()

Returns index version. All releases so far always returned 1.

getTimestamp

public Date getTimestamp()

Returns the index timestamp of last update of the index.

iterator

public Iterator<Map<String,String>> iterator()

Returns the Record iterator.

Specified by:

iterator in interface Iterable<Map<String,String>>

close

public void close()
           throws IOException

Closes this reader and it's underlying input.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException