Package: Closeable

Closeable

Coverage

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