documentapi/src/main/java/com/yahoo/documentapi/DocumentListVisitorResponse.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.documentapi;

import com.yahoo.vdslib.DocumentList;

/**
 * Visitor response containing a document list. All visitor responses have ack
 * tokens that must be acked.
 *
 * @author <a href="mailto:humbe@yahoo-inc.com">H&aring;kon Humberset</a>
 */
public class DocumentListVisitorResponse extends VisitorResponse {
    private DocumentList documents;

    /**
     * Creates visitor response containing a document list and an ack token.
     *
     * @param docs the document list
     * @param ack the ack token
     */
    public DocumentListVisitorResponse(DocumentList docs, AckToken ack) {
        super(ack);
        documents = docs;
    }

    /** @return the document list */
    public DocumentList getDocumentList() { return documents; }
}