com.amazon.carbonado.cursor

Interface SortBuffer<S>

All Superinterfaces:

java.util.Collection<S>, java.lang.Iterable<S>

All Known Implementing Classes:

ArraySortBuffer, MergeSortBuffer

public interface SortBuffer<S>
extends java.util.Collection<S>

Buffers up Storable instances allowing them to be sorted. Should any method need to throw an undeclared exception, wrap it with an UndeclaredThrowableException.

Author:

Brian S O'Neill

See Also:

SortedCursor

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Clear and close buffer.
void	prepare(java.util.Comparator<S> comparator) Clears buffer and assigns a comparator for sorting.
void	sort() Finish sorting buffer.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

prepare

void prepare(java.util.Comparator<S> comparator)

Clears buffer and assigns a comparator for sorting.

Throws:

java.lang.IllegalArgumentException - if comparator is null

sort

void sort()
          throws FetchException

Finish sorting buffer.

Throws:

java.lang.IllegalStateException - if prepare was never called

FetchException

close

void close()
           throws FetchException

Clear and close buffer.

Throws:

FetchException