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   */
20  package org.apache.directory.mavibot.btree;
21  
22  
23  /**
24   * An enum to describe the BTree type. We have three possible type :
25   * <ul>
26   * <li>IN_MEMORY : the BTree will remain in memory, and won't be persisted on disk</li>
27   * <li>PERSISTENT : the BTree is in memory, but will be persisted on disk</li>
28   * <li>MANAGED : the BTree is managed by a RecordManager, and some pages may
29   * be swapped out from memory on demand</li>
30   * </ul>
31   * 
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   */
34  public enum BTreeTypeEnum
35  {
36      /** Pure in-memory BTree, not persisted on disk */
37      IN_MEMORY,
38  
39      /** In-memory BTree but persisted on disk */
40      PERSISTENT,
41  
42      /** A BTree associated with a RecordManager */
43      MANAGED
44  }