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.api.ldap.model.cursor; 21 22 23 /** 24 * A monitor used by Cursors to detect conditions when they should stop 25 * performing some work during advance operations such as next(), previous(), 26 * first() etc, and release resources. 27 * 28 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 29 */ 30 public interface ClosureMonitor 31 { 32 /** 33 * Sets monitor state to closed, and sets the cause to a 34 * CursorClosedException without an error message string. 35 */ 36 void close(); 37 38 39 /** 40 * Sets monitor state to closed, and sets the cause to a 41 * CursorClosedException with a specific error message string. 42 * 43 * @param cause error message string 44 */ 45 void close( String cause ); 46 47 48 /** 49 * Sets monitor state to closed, and sets the cause to a specific 50 * Exception. 51 * 52 * @param cause the exception to associate with the closure 53 */ 54 void close( Exception cause ); 55 56 57 /** 58 * Gets whether the state of this ClosureMonitor is set to closed. 59 * 60 * @return true if state is closed, false if open 61 */ 62 boolean isClosed(); 63 64 65 /** 66 * Checks if state of this ClosureMonitor is set to closed and if so, 67 * throws the causing Exception. 68 * 69 * @throws CursorClosedException the cause of the closure 70 */ 71 void checkNotClosed() throws CursorClosedException; 72 73 74 /** 75 * Gets the cause of the closure. 76 * 77 * @return the causing Exception 78 */ 79 Exception getCause(); 80 }