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.server.xdbm;
21  
22  
23  import org.apache.directory.server.core.cursor.ClosureMonitor;
24  import org.apache.directory.server.core.cursor.CursorIterator;
25  import org.apache.directory.server.core.cursor.DefaultClosureMonitor;
26  
27  import java.util.Iterator;
28  
29  
30  /**
31   * An abstract TupleCursor.
32   *
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   * @version $$Rev$$
35   */
36  public abstract class AbstractTupleCursor<K,V> implements TupleCursor<K,V>
37  {
38      private ClosureMonitor monitor = new DefaultClosureMonitor();
39  
40      
41      public final void setClosureMonitor( ClosureMonitor monitor )
42      {
43          if ( monitor == null )
44          {
45              throw new NullPointerException( "monitor" );
46          }
47          this.monitor = monitor;
48      }
49      
50  
51      protected final void checkNotClosed( String operation ) throws Exception
52      {
53          monitor.checkNotClosed();
54      }
55  
56  
57      public final boolean isClosed()
58      {
59          return monitor.isClosed();
60      }
61  
62  
63      public void close() throws Exception
64      {
65          monitor.close();
66      }
67  
68  
69      public void close( Exception cause ) throws Exception
70      {
71          monitor.close( cause );
72      }
73  
74  
75      public Iterator<Tuple<K,V>> iterator()
76      {
77          return new CursorIterator<Tuple<K,V>>( this );
78      }
79  }