View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *  http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.directory.api.ldap.model.cursor;
20  
21  
22  /**
23   * An enumeration to represent the various states of a Cursor.
24   *
25   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
26   */
27  public enum CursorStateEnum
28  {
29      /** the Cursor has been created and so has not been positioned yet */
30      JUST_OPENED,
31  
32      /** the Cursor is positioned just before the first element */
33      BEFORE_FIRST,
34  
35      /** the Cursor is positioned just after the last element */
36      AFTER_LAST,
37  
38      /** the Cursor is positioned just before an element but not on any element */
39      BEFORE_INNER,
40  
41      /** the Cursor is positioned just after an element but not on any element */
42      AFTER_INNER,
43  
44      /** the Cursor is positioned on the first element */
45      ON_FIRST,
46  
47      /** the Cursor is positioned on the last element */
48      ON_LAST,
49  
50      /** the Cursor is positioned on an element */
51      ON_INNER,
52  
53      /** the Cursor is closed and not operations can be performed on it */
54      CLOSED
55  }