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  /**
25   * The result of an delete operation, when we have borrowed some element from a sibling.
26   * 
27   * @param <K> The type for the Key
28   * @param <V> The type for the stored value
29  
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public interface BorrowedFromSiblingResult<K, V> extends DeleteResult<K, V>
33  {
34      /**
35       * @return the modifiedSibling
36       */
37      Page<K, V> getModifiedSibling();
38  
39  
40      /**
41       * Tells if the sibling is on the left
42       * 
43       * @return True if the sibling is on the left
44       */
45      boolean isFromLeft();
46  
47  
48      /**
49       * Tells if the sibling is on the right
50       * 
51       * @return True if the sibling is on the right
52       */
53      boolean isFromRight();
54  }