1 /*
2 * This file is part of AceLogger.
3 *
4 * AceLogger is free software: you can redistribute it and/or modify it under the terms of the GNU
5 * Lesser General Public License as published by the Free Software Foundation, either version 3 of
6 * the License, or (at your option) any later version.
7 *
8 * AceLogger is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
9 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public License along with AceLogger.
13 * If not, see <http://www.gnu.org/licenses/lgpl-3.0.html>.
14 */
15 package net.sourceforge.acelogger.location.gatherer;
16
17 import net.sourceforge.acelogger.Identifiable;
18 import net.sourceforge.acelogger.location.LogEventLocation;
19
20 /**
21 * Obtains the location of a log call.
22 *
23 * @author Zardi (https://sourceforge.net/users/daniel_zardi)
24 * @version 1.0.0
25 * @since 1.0.0
26 */
27 public interface LocationGatherer extends Identifiable {
28
29 /**
30 * Obtains the log call location, such as the package, class and method names.
31 *
32 * @return A logCallLocation with information of the caller location.
33 * @since 1.0.0
34 */
35 public LogEventLocation getCallLocation();
36
37 /**
38 * Obtains the log call location, such as the package, class and method names.
39 *
40 * @param currentThread
41 * The thread that originated the call.
42 * @return A logCallLocation with information of the caller location.
43 * @since 1.0.0
44 */
45 public LogEventLocation getCallLocation(Thread currentThread);
46
47 }