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


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

// 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 the order of the elements of
 * the list is insignificant. The usage of this is to allow the content of a list to be rendered in the order
 * in which it completes rather than in the order in which it is added to the list.
 *
 * @author  <a href="mailto:bratseth@yahoo-inc.com">Jon Bratseth</a>
 * @since   5.1.19
 */
public interface Ordered {

    /** Returns false if the data in this list can be returned in any order. Default: true, meaning the order matters */
    public boolean isOrdered();

}