Skip to content

Package: ClasspathScanner

ClasspathScanner

Coverage

1: /**
2: * Copyright (C) 2022 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.jopa.loaders;
16:
17: import java.util.function.Consumer;
18:
19: /**
20: * Scans application classpath, allowing to find classes of significance (e.g., entity classes).
21: */
22: public interface ClasspathScanner {
23:
24: /**
25: * Registers a listener to which discovered classes will be passed for processing.
26: *
27: * @param listener Listener to invoke with discovered classes
28: */
29: void addListener(Consumer<Class<?>> listener);
30:
31: /**
32: * Start class processing, looking for classes in the specified package (and its descendants).
33: *
34: * @param scanPackage Package to scan
35: */
36: void processClasses(String scanPackage);
37: }