Cursor.java

/*
 * Copyright 2014 the original author or authors.
 *
 * 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 org.springframework.data.redis.core;

import java.io.Closeable;
import java.util.Iterator;

/**
 * @author Christoph Strobl
 * @param <T>
 * @since 1.4
 */
public interface Cursor<T> extends Iterator<T>, Closeable {

	/**
	 * Get the reference cursor. <br>
	 * <strong>NOTE:</strong> the id might change while iterating items.
	 * 
	 * @return
	 */
	long getCursorId();

	/**
	 * @return Returns true if cursor closed.
	 */
	boolean isClosed();

	/**
	 * Opens cursor and returns itself.
	 * 
	 * @return
	 */
	Cursor<T> open();

	/**
	 * @return Returns the current position of the cursor.
	 */
	long getPosition();

}