110 lines
3.3 KiB
Java
110 lines
3.3 KiB
Java
/*
|
|
* This file is part of Player Analytics (Plan).
|
|
*
|
|
* Plan is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License v3 as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Plan is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Plan. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
package com.djrapitops.plan.api;
|
|
|
|
import com.djrapitops.plan.api.data.PlayerContainer;
|
|
import com.djrapitops.plan.api.data.ServerContainer;
|
|
import com.djrapitops.plan.data.plugin.PluginData;
|
|
import com.djrapitops.plan.identification.UUIDUtility;
|
|
import com.djrapitops.plan.storage.database.DBSystem;
|
|
import com.djrapitops.plan.utilities.logging.ErrorLogger;
|
|
import net.playeranalytics.plugin.server.PluginLogger;
|
|
|
|
import javax.inject.Inject;
|
|
import javax.inject.Singleton;
|
|
import java.util.Collection;
|
|
import java.util.Map;
|
|
import java.util.Optional;
|
|
import java.util.UUID;
|
|
|
|
/**
|
|
* Interface for PlanAPI methods.
|
|
*
|
|
* @author AuroraLS3
|
|
* @deprecated Plan API v4 has been deprecated, use the APIv5 instead (<a href="https://github.com/plan-player-analytics/Plan/wiki/APIv5">wiki</a>).
|
|
*/
|
|
@Deprecated(since = "5.0")
|
|
public interface PlanAPI {
|
|
|
|
static PlanAPI getInstance() {
|
|
return Optional.ofNullable(PlanAPIHolder.api)
|
|
.orElseThrow(() -> new IllegalStateException("PlanAPI has not been initialised yet."));
|
|
}
|
|
|
|
@Singleton
|
|
class PlanAPIHolder {
|
|
static PlanAPI api;
|
|
|
|
static void set(PlanAPI api) {
|
|
PlanAPIHolder.api = api;
|
|
}
|
|
|
|
@Inject
|
|
public PlanAPIHolder(
|
|
DBSystem dbSystem,
|
|
UUIDUtility uuidUtility,
|
|
PluginLogger logger,
|
|
ErrorLogger errorLogger
|
|
) {
|
|
set(new CommonAPI(dbSystem, uuidUtility, logger, errorLogger));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @deprecated PluginData API has been deprecated - see <a href="https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API">wiki</a> for new API.
|
|
*/
|
|
@Deprecated
|
|
void addPluginDataSource(PluginData pluginData);
|
|
|
|
String getPlayerInspectPageLink(UUID uuid);
|
|
|
|
String getPlayerInspectPageLink(String playerName);
|
|
|
|
String getPlayerName(UUID uuid);
|
|
|
|
UUID playerNameToUUID(String playerName);
|
|
|
|
Map<UUID, String> getKnownPlayerNames();
|
|
|
|
/**
|
|
* Fetch PlayerContainer from the database.
|
|
* <p>
|
|
* Blocking operation.
|
|
*
|
|
* @param uuid UUID of the player.
|
|
* @return a {@link PlayerContainer}.
|
|
*/
|
|
PlayerContainer fetchPlayerContainer(UUID uuid);
|
|
|
|
/**
|
|
* Fetch a ServerContainer from the database.
|
|
* <p>
|
|
* Blocking operation.
|
|
*
|
|
* @param serverUUID UUID of the server.
|
|
* @return a {@link ServerContainer}.
|
|
*/
|
|
ServerContainer fetchServerContainer(UUID serverUUID);
|
|
|
|
/**
|
|
* Fetch server UUIDs.
|
|
*
|
|
* @return All Plan server UUIDs.
|
|
*/
|
|
Collection<UUID> fetchServerUUIDs();
|
|
}
|