main.java.com.djrapitops.plan.api

Class API

java.lang.Object

main.java.com.djrapitops.plan.api.API

public class API
extends Object

This class contains the API methods. Methods can be called from Asyncronous task and are thread safe unless otherwise stated.

Since:

2.0.0

Author:

Rsl1122

Constructor Summary

Constructors

Constructor and Description
API(Plan plugin) Class Construcor.

Method Summary

Modifier and Type	Method and Description
void	addPluginDataSource(PluginData dataSource) Add a source of plugin data to the Plugins tab on Analysis and/or Inspect page.
void	cacheUserDataToInspectCache(UUID uuid) Cache the UserData to InspectCache.
AnalysisData	getAnalysisDataFromCache() Used to get the AnalysisData object.
String	getAnalysisHtmlAsString() Used to get the full Html of the Analysis page as a string.
String	getPlayerHtmlAsString(UUID uuid) Used to get the full Html of the Inspect page as a string.
String	getPlayerInspectPageLink(String name) Used to get the link to InspectPage of a player.
String	getPlayerName(UUID uuid) Used to get the playerName of a player who has played on the server.
boolean	isAnalysisCached() Check if the Analysis has been run and is cached to the AnalysisCache.
boolean	isEnabled() Check whether or not the plugin enabled successfully.
boolean	isPlayersDataInspectCached(UUID uuid) Check if the UserData is cached to the InspectCache.
void	placeDataToCache(UserData data) Used to cache a UserData object.
UUID	playerNameToUUID(String playerName) Uses UUIDFetcher to turn PlayerName to UUID.
void	saveCachedData() Used to save the cached data to the database.
void	scheduleEventHandlingInfo(HandlingInfo info) Schedule a HandlingInfo object to be processed.
void	scheduleForGet(UUID uuid, DBCallableProcessor processor) Schedule a UserData object to be fetched from the database or cache if the player is online.
void	updateAnalysisCache() Run's the analysis with the current data in the cache and fetches rest from the database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

API

public API(Plan plugin)

Class Construcor.

Parameters:

plugin - Current instance of Plan

Method Detail

isEnabled

public boolean isEnabled()

Check whether or not the plugin enabled successfully.

Returns:

true if plugin is enabled correctly.

addPluginDataSource

public void addPluginDataSource(PluginData dataSource)

Add a source of plugin data to the Plugins tab on Analysis and/or Inspect page. Refer to documentation on github or Javadoc of PluginData to set-up a data source that extends PluginData correctly.

Parameters:

dataSource - an object that extends PluginData-object, thus allowing Analysis and Inspect to manage the data of a plugin correctly.

See Also:

PluginData

getPlayerInspectPageLink

public String getPlayerInspectPageLink(String name)

Used to get the link to InspectPage of a player. This method is useful if you have a table and want to link to the inspect page. Html.LINK.parse("Link", "Playername") can be used to get a link <a href="Link">Playername</a>

Parameters:

name - Playername of the player

Returns:

ip:port/security/player/Playername

scheduleForGet

public void scheduleForGet(UUID uuid,
                           DBCallableProcessor processor)

Schedule a UserData object to be fetched from the database or cache if the player is online. The data will not be cached if it is not already cached.

Parameters:

uuid - UUID of the player.

processor - Object implementing DBCallableProcessor, which process(UserData data) method will be called.

scheduleEventHandlingInfo

public void scheduleEventHandlingInfo(HandlingInfo info)

Schedule a HandlingInfo object to be processed. UserData associated with the UUID of the HandlingInfo object will be cached.

Parameters:

info - object that extends HandlingInfo.

placeDataToCache

public void placeDataToCache(UserData data)

Used to cache a UserData object. If data is already cached it will be overridden.

Parameters:

data - UserData object. Will be placed to the data.getUuid() key in the cache.

saveCachedData

public void saveCachedData()

Used to save the cached data to the database. Should be only called from an Asyncronous thread.

isPlayersDataInspectCached

public boolean isPlayersDataInspectCached(UUID uuid)

Check if the UserData is cached to the InspectCache.

Parameters:

uuid - UUID of the player.

Returns:

true/false

cacheUserDataToInspectCache

public void cacheUserDataToInspectCache(UUID uuid)

Cache the UserData to InspectCache. Uses cache if data is cached or database if not. Call from an Asyncronous thread.

Parameters:

uuid - UUID of the player.

getPlayerHtmlAsString

public String getPlayerHtmlAsString(UUID uuid)

Used to get the full Html of the Inspect page as a string. Check if the data is cached to InspectCache before calling this.

Parameters:

uuid - UUID of the player.

Returns:

player.html with all placeholders replaced.

isAnalysisCached

public boolean isAnalysisCached()

Check if the Analysis has been run and is cached to the AnalysisCache.

Returns:

true/false

updateAnalysisCache

public void updateAnalysisCache()

Run's the analysis with the current data in the cache and fetches rest from the database. Starts a new Asyncronous task to run the analysis.

getAnalysisHtmlAsString

public String getAnalysisHtmlAsString()

Used to get the full Html of the Analysis page as a string. Check if the data is cached to AnalysisCache before calling this.

Returns:

analysis.html with all placeholders replaced.

getAnalysisDataFromCache

public AnalysisData getAnalysisDataFromCache()

Used to get the AnalysisData object. Check if the data is cached to AnalysisCache before calling this.

Returns:

AnalysisData object.

See Also:

AnalysisData

getPlayerName

public String getPlayerName(UUID uuid)
                     throws IllegalStateException

Used to get the playerName of a player who has played on the server.

Parameters:

uuid - UUID of the player.

Returns:

Playername, eg "Rsl1122"

Throws:

IllegalStateException - If the player has not played on the server before.

playerNameToUUID

public UUID playerNameToUUID(String playerName)
                      throws Exception

Uses UUIDFetcher to turn PlayerName to UUID.

Parameters:

playerName - Player's name

Returns:

UUID of the Player

Throws:

Exception - if player's name is not registered at Mojang