processing/src/main/java/com/yahoo/processing/response/Streamed.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.processing.response;

/**
 * This is an <i>optional marker interface</i>.
 * DataLists may implement this to return false to indicate that no data from the list should be returned to clients
 * until it is completed. This is useful in cases where some decision making which may impact the content of the list
 * must be deferred until the list is complete.
 *
 * @author  <a href="mailto:bratseth@yahoo-inc.com">Jon Bratseth</a>
 * @since   5.1.19
 */
public interface Streamed {

    /**
     * Returns false if the data in this list can not be returned until it is completed.
     * Default: true, meaning eager streaming of the data is permissible.
     */
    public boolean isStreamed();

}