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 */ 019 package org.apache.directory.shared.ldap.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 * @version $Rev$, $Date$ 027 */ 028 public enum CursorStateEnum 029 { 030 /** the Cursor has been created and so has not been positioned yet */ 031 JUST_OPENED, 032 033 /** the Cursor is positioned just before the first element */ 034 BEFORE_FIRST, 035 036 /** the Cursor is positioned just after the last element */ 037 AFTER_LAST, 038 039 /** the Cursor is positioned just before an element but not on any element */ 040 BEFORE_INNER, 041 042 /** the Cursor is positioned just after an element but not on any element */ 043 AFTER_INNER, 044 045 /** the Cursor is positioned on the first element */ 046 ON_FIRST, 047 048 /** the Cursor is positioned on the last element */ 049 ON_LAST, 050 051 /** the Cursor is positioned on an element */ 052 ON_INNER, 053 054 /** the Cursor is closed and not operations can be performed on it */ 055 CLOSED 056 }