com.spotify.sparkey

Interface SparkeyReader

All Superinterfaces:

Iterable<SparkeyReader.Entry>

All Known Implementing Classes:

ReloadableSparkeyReader, ThreadLocalSparkeyReader

public interface SparkeyReader
extends Iterable<SparkeyReader.Entry>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SparkeyReader.Entry
static class	SparkeyReader.Type

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
SparkeyReader	duplicate() Create a duplicate of the reader.
byte[]	getAsByteArray(byte[] key)
SparkeyReader.Entry	getAsEntry(byte[] key) This is mostly useful for retrieving large values that don't fit in a byte array.
String	getAsString(String key)
IndexHeader	getIndexHeader()
LogHeader	getLogHeader()
Iterator<SparkeyReader.Entry>	iterator() Get an iterator over all the live entries.

Method Detail

getAsString

String getAsString(String key)
                   throws IOException

Parameters:

key - the key to search for, interpreted as an UTF-8 string.

Returns:

null if the key/value pair was not found, otherwise the value interpreted as an UTF-8 string.

Throws:

IOException

getAsByteArray

byte[] getAsByteArray(byte[] key)
                      throws IOException

Parameters:

key - the key to search for

Returns:

null if the key/value pair was not found, otherwise the raw byte array value

Throws:

IOException

getAsEntry

SparkeyReader.Entry getAsEntry(byte[] key)
                               throws IOException

This is mostly useful for retrieving large values that don't fit in a byte array.

Parameters:

key - the key to search for

Returns:

null if the key/value pair was not found, otherwise the entry.

Throws:

IOException

close

void close()
           throws IOException

Throws:

IOException

getIndexHeader

IndexHeader getIndexHeader()

getLogHeader

LogHeader getLogHeader()

duplicate

SparkeyReader duplicate()

Create a duplicate of the reader. Useful for using the reader from another thread.

Returns:

a duplicate of the reader.

iterator

Iterator<SparkeyReader.Entry> iterator()

Get an iterator over all the live entries. The iterator object is not thread safe, and the entry objects are highly volatile and will be invalidated by the next iteration step. Don't leak this entry, copy whatever data you want from it instead.

Specified by:

iterator in interface Iterable<SparkeyReader.Entry>

Returns:

an iterator