Package: Closeable

Closeable

Coverage

1: /**
2: * Copyright (C) 2016 Czech Technical University in Prague
3: *
4: * This program is free software: you can redistribute it and/or modify it under
5: * the terms of the GNU General Public License as published by the Free Software
6: * Foundation, either version 3 of the License, or (at your option) any
7: * later version.
8: *
9: * This program is distributed in the hope that it will be useful, but WITHOUT
10: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12: * details. You should have received a copy of the GNU General Public License
13: * along with this program. If not, see <http://www.gnu.org/licenses/>.
14: */
15: package cz.cvut.kbss.ontodriver;
16:
17: import cz.cvut.kbss.ontodriver.exception.OntoDriverException;
18:
19: /**
20: * Interface for closeable resources.
21: *
22: * @author kidney
23: *
24: */
25: public interface Closeable {
26:
27:         /**
28:          * Closes this resource releasing any sub-resources it holds. </p>
29:          *
30:          * After closing the resource is not usable any more and calling methods on
31:          * it (except {@code close} and {@code isOpen}) will result in
32:          * {@code IllegalStateException}. </p>
33:          *
34:          * Calling {@code close} on already closed resource does nothing.
35:          *
36:          * @throws OntoDriverException
37:          * If an ontology access error occurs.
38:          */
39:         void close() throws OntoDriverException;
40:
41:         /**
42:          * Retrieves status of this resource. </p>
43:          *
44:          * @return {@code true} if the resource is open, {@code false} otherwise
45:          */
46:         boolean isOpen();
47:
48: }