KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ldap > server > db > TupleBrowser


1 /*
2  * Copyright 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 package org.apache.ldap.server.db;
18
19
20 import javax.naming.NamingException JavaDoc;
21
22
23 /**
24  * TupleBrowser interface used to abstract
25  *
26  * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
27  * @version $Rev: 169198 $
28  */
29 public interface TupleBrowser
30 {
31     /**
32      * Gets the next value deemed greater than the last using the key
33      * comparator.
34      *
35      * @param tuple the tuple to populate with a key/value pair
36      * @return true if there was a next that was populated or false otherwise
37      * @throws NamingException @todo
38      */
39     boolean getNext( Tuple tuple ) throws NamingException JavaDoc;
40
41     /**
42      * Gets the previous value deemed greater than the last using the key
43      * comparator.
44      *
45      * @param tuple the tuple to populate with a key/value pair
46      * @return true if there was a previous value populated or false otherwise
47      * @throws NamingException @todo
48      */
49     boolean getPrevious( Tuple tuple ) throws NamingException JavaDoc;
50 }
51
Popular Tags