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.mitosis.store;
21  
22  
23  import java.sql.ResultSet;
24  
25  import org.apache.directory.mitosis.operation.Operation;
26  import org.apache.directory.server.schema.registries.Registries;
27  
28  /**
29   * Iterates a set of {@link Operation}s, which is a result of a query on 
30   * {@link ReplicationStore}.  It's usage is similar to that of JDBC
31   * {@link ResultSet}.
32   * 
33   * @author The Apache Directory Project (dev@directory.apache.org)
34   * @version $Rev$, $Date$
35   */
36  public interface ReplicationLogIterator
37  {
38      /**
39       * Move on to the next item.
40       * @return <tt>true</tt> if and only if it has more item.
41       */
42      boolean next();
43  
44      /**
45       * Releases all resources allocated to this iterator.
46       */
47      void close();
48  
49      /**
50       * Returns the {@link Operation} on the current iterator position.
51       */
52      Operation getOperation( Registries registries );
53  }