io.vertx.core.spi.cluster.ChoosableIterable.java Source code

Introduction

Here is the source code for io.vertx.core.spi.cluster.ChoosableIterable.java

Source

/*
 * Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.spi.cluster;

/**
 *
 * An extension of Iterable which allows keeps track of an iterator internally to allow the next element to be chosen
 *
 * @author <a href="http://tfox.org">Tim Fox</a>
 *
 */
public interface ChoosableIterable<T> extends Iterable<T> {

    /**
     * Is it empty?
     */
    boolean isEmpty();

    /**
     * Return the next element T in a round robin fashion. The implementation should internally maintain some state
     * which allows the next element to be returned
     * @return The next element
     */
    T choose();
}