com.cloudhopper.datastore.AscendingIteratorSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ch-datastore Show documentation

The newest version!

package com.cloudhopper.datastore;

/*
 * #%L
 * ch-datastore
 * %%
 * Copyright (C) 2012 Cloudhopper by Twitter
 * %%
 * 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.
 * #L%
 */

/**
 * Interface for indicating a DataStore supports a DataStoreIterator in an
 * ascending order.
 * 
 * @author joelauer
 */
public interface AscendingIteratorSupport {

    /**
     * Gets a DataStoreIterator that will fetch records by keys in their
     * ascending order.
     * @return A new DataStoreIterator
     * @throws DataStoreFatalException 
     */
    public DataStoreIterator doGetAscendingIterator() throws DataStoreFatalException;

}