♻️ Move constants out of the class
[Sone.git] / src / main / kotlin / net / pterodactylus / sone / database / SoneProvider.kt
1 /*
2  * Sone - SoneProvider.java - Copyright © 2011–2019 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.database
19
20 import com.google.inject.*
21 import net.pterodactylus.sone.core.*
22 import net.pterodactylus.sone.data.*
23
24 /**
25  * Interface for objects that can provide [Sone]s by their ID.
26  */
27 @ImplementedBy(Core::class)
28 interface SoneProvider {
29
30         val sones: Collection<Sone>
31         val localSones: Collection<Sone>
32         val remoteSones: Collection<Sone>
33         val soneLoader: (String) -> Sone?
34
35         fun getSone(soneId: String): Sone?
36
37 }