001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.apache.directory.api.ldap.model.cursor; 020 021 022/** 023 * An enumeration to represent the various states of a Cursor. 024 * 025 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 026 */ 027public enum CursorStateEnum 028{ 029 /** the Cursor has been created and so has not been positioned yet */ 030 JUST_OPENED, 031 032 /** the Cursor is positioned just before the first element */ 033 BEFORE_FIRST, 034 035 /** the Cursor is positioned just after the last element */ 036 AFTER_LAST, 037 038 /** the Cursor is positioned just before an element but not on any element */ 039 BEFORE_INNER, 040 041 /** the Cursor is positioned just after an element but not on any element */ 042 AFTER_INNER, 043 044 /** the Cursor is positioned on the first element */ 045 ON_FIRST, 046 047 /** the Cursor is positioned on the last element */ 048 ON_LAST, 049 050 /** the Cursor is positioned on an element */ 051 ON_INNER, 052 053 /** the Cursor is closed and not operations can be performed on it */ 054 CLOSED 055}