Interface ContentDomainEnumerator<T>

  • Type Parameters:
    T - The type of content.

    public interface ContentDomainEnumerator<T>
    Content domain enumerator. Definition of how to enumerate over content for a given domain.
    • Method Detail

      • getDomainPrefix

        String getDomainPrefix()
        Returns the domain prefix.
        Returns:
        Domain prefix.
      • getBookmark

        String getBookmark​(T content)
        Returns the bookmark for the given content.
        Parameters:
        content - Content to retrieve its bookmark for.
        Returns:
        Bookmark.
      • getEnumeration

        List<T> getEnumeration​(String bookmark,
                               int limit)
                        throws IndexQueueException
        Returns an enumeration of content.
        Parameters:
        bookmark - Content domain bookmark, indicating the start point. In case of the initial call for this domain bookmark will be null.
        limit - The size of the returned list of content items.
        Returns:
        Unmodifiable list of content. Might contain null items so calling code has to check for null.
        Throws:
        IndexQueueException - indicates a failure.