com.basho.riak.client.query.StreamingOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riak-client Show documentation

HttpClient-based client for Riak

There is a newer version: 2.1.1

/*
 * Copyright 2013 Basho Technologies Inc
 *
 * 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.basho.riak.client.query;

import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

/**
 * Encapsulates a streaming Riak operation.
 * 
 * @author Brian Roach 
 */
public interface StreamingOperation extends Iterable, Iterator
{
    /**
     * Retrieve all elements from the operation and return them in a List
     * 
     * @return a List containing all elements resulting from the operation
     * @throws IOException if a network error occurs 
     */
    List getAll();
    
    /**
     * Cancels the operation and cleans up the underlying network connection
     */
    void cancel();
    
    /**
     * If this is a paginated operation, a "continuation" value may be available
     */
    boolean hasContinuation();
    
    /**
     * Get the continuation value 
     * @return A string representation of the continuation value or null if not present
     */
    String getContinuation();
}