All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.hazelcast.sql.impl.ResultIterator Maven / Gradle / Ivy

There is a newer version: 5.0-BETA-1
Show newest version
/*
 * Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.sql.impl;

import java.util.Iterator;
import java.util.concurrent.TimeUnit;

/**
 * Java standard {@link Iterator} enhanced with {@link #hasNext(long,
 * TimeUnit)} to allow for non-blocking iteration.
 */
public interface ResultIterator extends Iterator {

    /**
     * Checks if a next item is available, with a timeout.
     * 

* The implementation is allowed to block until an item is available and * never actually return TIMEOUT response. *

* This can be used to implement either blocking or non-blocking behavior. * * @return see {@link HasNextResult} * @param timeout the timeout, 0 means check an immediate next item */ HasNextResult hasNext(long timeout, TimeUnit timeUnit); enum HasNextResult { /** * The next item is available immediately. Subsequent {@link #next()} call * is guaranteed to succeed and not block. */ YES, /** * Another item is not available immediately, but might be available later. * The caller should check again later. Also there might not be a next * item at all. */ TIMEOUT, /** * The last item was already returned. A call to {@link #next()} will fail. * The iterator is exhausted. */ DONE } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy