Package: Closeable

Closeable

Coverage

1: /**
2: * Copyright (C) 2020 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: public interface Closeable {
23:
24: /**
25: * Closes this resource releasing any sub-resources it holds.
26: * <p>
27: * After closing the resource is not usable any more and calling methods on
28: * it (except {@code close} and {@code isOpen}) will result in
29: * {@code IllegalStateException}.
30: * <p>
31: * Calling {@code close} on already closed resource does nothing.
32: *
33: * @throws OntoDriverException If an ontology access error occurs.
34: */
35: void close() throws OntoDriverException;
36:
37: /**
38: * Retrieves status of this resource.
39: *
40: * @return {@code true} if the resource is open, {@code false} otherwise
41: */
42: boolean isOpen();
43:
44: }