com.google.enterprise.connector.util.diffing

Interface SnapshotRepository<T extends DocumentSnapshot>

All Superinterfaces:

java.lang.Iterable<T>

public interface SnapshotRepository<T extends DocumentSnapshot>
extends java.lang.Iterable<T>

Interface for accessing a sequence of DocumentSnapshot objects from a repository. The returned objects are are sorted by DocumentSnapshot.getDocumentId() values.

Since:

2.8

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name for this SnapshotRepository.
java.util.Iterator<T>	iterator() Returns an Iterator to access the collection of DocumentSnapshot objects from the repository.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getName

java.lang.String getName()

Returns the name for this SnapshotRepository. The returned name must be unique for the containing Connector.

iterator

java.util.Iterator<T> iterator()
                        throws SnapshotRepositoryRuntimeException

Returns an Iterator to access the collection of DocumentSnapshot objects from the repository. The returned Iterator must return DocumentSnapshot objects in DocumentSnapshot.getDocumentId() order.

The returned Iterator may throw the unchecked SnapshotRepositoryRuntimeException if Iterator.hasNext() or Iterator.next() fails. The returned Iterator need not implement Iterator.remove().

Specified by:

iterator in interface java.lang.Iterable<T extends DocumentSnapshot>

Throws:

SnapshotRepositoryRuntimeException