API (Plan 4.0.0 API)

java.lang.Object
- main.java.com.djrapitops.plan.api.API

```
public class API
extends Object
```
This class contains the API methods for Bukkit version of the plugin.
Methods can be called from Asynchronous task and are thread safe unless otherwise stated.
Use Plan.getPlanAPI() to get the API.
More information about API methods can be found on GitHub.

Since:

2.0.0

Author:

Rsl1122

See Also:

PluginData, AnalysisType

Constructor Summary

Constructors
Constructor and Description

API(Plan plugin)
Class Constructor.

Constructors
Constructor and Description
`API(Plan plugin)` Class Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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`	`cachePlayerHtml(UUID uuid)` Cache Players's Inspect page to the PageCache of the WebServer.
`void`	`cacheUserDataToInspectCache(UUID uuid)` Deprecated. use `cachePlayerHtml`
`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 a relative link to InspectPage of a player.
`String`	`getPlayerName(UUID uuid)` Used to get the PlayerName of a player who has played on the server.
`Collection<UUID>`	`getSavedUUIDs()` Get the saved UUIDs in the database.
`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`	`isPlayerHtmlCached(UUID uuid)`
`boolean`	`isPlayersDataInspectCached(UUID uuid)` Deprecated. use `isPlayerHtmlCached`
`UUID`	`playerNameToUUID(String playerName)` Uses UUIDUtility to turn PlayerName to UUID.
`UUID`	`PlayerNameToUUID(String playerName)` Deprecated. Typo in method name, use playerNameToUUID instead
`void`	`updateAnalysisCache()` Run the analysis.

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 Constructor.
    
    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 a relative 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 - Name of the player
    
    Returns:
    
    ./player/PlayerName
  - isPlayersDataInspectCached
```
@Deprecated
public boolean isPlayersDataInspectCached(UUID uuid)
```
    Deprecated. use isPlayerHtmlCached
    
    Check if Players's Inspect page is cached to pagecache.
    
    Parameters:
    
    uuid - UUID of the player.
    
    Returns:
    
    true/false
  - isPlayerHtmlCached
```
public boolean isPlayerHtmlCached(UUID uuid)
```
  - cacheUserDataToInspectCache
```
@Deprecated
public void cacheUserDataToInspectCache(UUID uuid)
```
    Deprecated. use cachePlayerHtml
    
    Cache Players's Inspect page to the PageCache of the WebServer.
    
    Parameters:
    
    uuid - UUID of the player.
  - cachePlayerHtml
```
public void cachePlayerHtml(UUID uuid)
```
    Cache Players's Inspect page to the PageCache of the WebServer.
    
    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 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:
    
    server.html with all placeholders replaced.
    
    Throws:
    
    NullPointerException - if AnalysisData has not been cached.
  - 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 SQLException
```
    Used to get the PlayerName of a player who has played on the server. Should be called from an Async thread.
    
    Parameters:
    
    uuid - UUID of the player.
    
    Returns:
    
    PlayerName, eg "Rsl1122"
    
    Throws:
    
    IllegalArgumentException - If uuid is null.
    
    IllegalStateException - If the player has not played on the server before.
    
    SQLException
  - PlayerNameToUUID
```
@Deprecated
public UUID PlayerNameToUUID(String playerName)
                                   throws Exception
```
    Deprecated. Typo in method name, use playerNameToUUID instead
    
    Uses UUIDUtility 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
  - playerNameToUUID
```
public UUID playerNameToUUID(String playerName)
```
    Uses UUIDUtility to turn PlayerName to UUID.
    
    Parameters:
    
    playerName - Player's name
    
    Returns:
    
    UUID of the Player
    
    Throws:
    
    IllegalArgumentException - if player's name is not registered at Mojang
  - getSavedUUIDs
```
public Collection<UUID> getSavedUUIDs()
                               throws SQLException
```
    Get the saved UUIDs in the database.
    Should be called from async thread.
    
    Returns:
    
    Collection of UUIDs that can be found in the database.
    
    Throws:
    
    SQLException - If database error occurs.
    
    Since:
    
    3.4.2

Class API

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

API

Method Detail

isEnabled

addPluginDataSource

getPlayerInspectPageLink

isPlayersDataInspectCached

isPlayerHtmlCached

cacheUserDataToInspectCache

cachePlayerHtml

getPlayerHtmlAsString

isAnalysisCached

updateAnalysisCache

getAnalysisHtmlAsString

getAnalysisDataFromCache

getPlayerName

PlayerNameToUUID

playerNameToUUID

getSavedUUIDs