DataCacheHandler (Plan 3.1.1 API)

java.lang.Object
- main.java.com.djrapitops.plan.data.cache.SessionCache
- - main.java.com.djrapitops.plan.data.cache.LocationCache
  - - main.java.com.djrapitops.plan.data.cache.DataCacheHandler

```
public class DataCacheHandler
extends LocationCache
```
This Class contains the Cache. This class is the main processing class that initializes Save, Clear, Process and Get queue and Starts the asyncronous save task. It is used to store commanduse, locations, active sessions and UserData objects in memory. It's methods can be used to access all the data it stores and to clear them.

Since:

2.0.0

Author:

Rsl1122

Constructor Summary

Constructors
Constructor and Description

DataCacheHandler(Plan plugin)
Class Constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToPool(HandlingInfo i)` Used to add event HandlingInfo to the processTask's pool.
`void`	`cache(UserData data)` Used to Cache a UserData object to the Cache.
`void`	`clearCache()` Schedules all UserData from the Cache to be cleared.
`void`	`clearFromCache(UUID uuid)` Clears the matching UserData from the Cache if they're not online.
`Map<String,Integer>`	`getCommandUse()` Used to get the cached commandUse.
`boolean`	`getCommandUseFromDb()` Used to get the initial commandUse Map from the database.
`HashMap<UUID,UserData>`	`getDataCache()` Used to get the contents of the cache.
`int`	`getMaxPlayers()` Used by Analysis for Player activity graphs.
`void`	`getUserDataForProcessing(DBCallableProcessor processor, UUID uuid)` Uses Database or Cache to retrieve the UserData of a matching player.
`void`	`getUserDataForProcessing(DBCallableProcessor processor, UUID uuid, boolean cache)` Uses Database or Cache to retrieve the UserData of a matching player.
`void`	`handleCommand(String command)` Used to handle a command's execution.
`void`	`handleReload()` If /reload is run this treats every online player as a new login.
`boolean`	`isDataAccessed(UUID uuid)` Check whether or not the UserData object is being accessed by save or process tasks.
`void`	`newPlayer(org.bukkit.OfflinePlayer player)` Creates a new UserData instance and saves it to the Database.
`void`	`newPlayer(org.bukkit.entity.Player player)` Creates a new UserData instance and saves it to the Database.
`void`	`newPlayer(UserData data)` Schedules a new player's data to be saved to the Database.
`void`	`saveCachedData(UUID uuid)` Saves the cached data of matching Player if it is in the cache.
`void`	`saveCachedUserData()` Saves all UserData in the cache to Database.
`void`	`saveCacheOnDisable()` Saves all data in the cache to Database and closes the database down.
`void`	`saveCommandUse()` Saves the cached CommandUse.
`void`	`saveHandlerDataToCache()` Refreshes the calculations for all online players with ReloadInfo.
`void`	`scheludeForClear(UUID uuid)` Schedules a matching UserData object to be cleared from the cache.
`void`	`startAsyncPeriodicSaveTask()` Used to start the Asyncronous Save Task.
`void`	`startQueues()` Used to start all processing Queue Threads.

Methods inherited from class main.java.com.djrapitops.plan.data.cache.LocationCache
addLocation, addLocations, clearLocations, getLocationsForSaving

Methods inherited from class main.java.com.djrapitops.plan.data.cache.SessionCache
addSession, endSession, getActiveSessions, getSession, startSession

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DataCacheHandler
```
public DataCacheHandler(Plan plugin)
```
    Class Constructor. Gets the Database from the plugin. Starts the queues. Registers Asyncronous Periodic Save Task
    
    Parameters:
    
    plugin - Current instance of Plan
- Method Detail
  - getCommandUseFromDb
```
public boolean getCommandUseFromDb()
```
    Used to get the initial commandUse Map from the database.
    
    Returns:
    
    Was the fetch successful?
  - startQueues
```
public void startQueues()
```
    Used to start all processing Queue Threads.
  - startAsyncPeriodicSaveTask
```
public void startAsyncPeriodicSaveTask()
                                throws IllegalArgumentException,
                                       IllegalStateException
```
    Used to start the Asyncronous Save Task.
    
    Throws:
    
    IllegalArgumentException - BukkitRunnable was given wrong parameters.
    
    IllegalStateException - BukkitScheduler is in a wrong state.
  - getUserDataForProcessing
```
public void getUserDataForProcessing(DBCallableProcessor processor,
                                     UUID uuid,
                                     boolean cache)
```
    Uses Database or Cache to retrieve the UserData of a matching player. Caches the data to the Cache if cache-parameter is true.
    
    Parameters:
    
    processor - DBCallableProcessor Object used to process the data after it was retrieved
    
    uuid - Player's UUID
    
    cache - Whether or not the UserData will be Cached in this instance of DataCacheHandler after it has been fetched (if not already fetched)
  - cache
```
public void cache(UserData data)
```
    Used to Cache a UserData object to the Cache. If a object already exists it will be replaced.
    
    Parameters:
    
    data - UserData object with the UUID inside used as key.
  - getUserDataForProcessing
```
public void getUserDataForProcessing(DBCallableProcessor processor,
                                     UUID uuid)
```
    Uses Database or Cache to retrieve the UserData of a matching player. Always Caches the data after retrieval (unless already cached)
    
    Parameters:
    
    processor - DBCallableProcessor Object used to process the data after it was retrieved
    
    uuid - Player's UUID
  - saveCachedUserData
```
public void saveCachedUserData()
```
    Saves all UserData in the cache to Database. ATTENTION: TODO - Doesn't save the Locations in the locationCache. Should only be called from Async thread
  - addToPool
```
public void addToPool(HandlingInfo i)
```
    Used to add event HandlingInfo to the processTask's pool. Given HandlingInfo object's process method will be called.
    
    Parameters:
    
    i - Object that extends HandlingInfo.
  - saveCacheOnDisable
```
public void saveCacheOnDisable()
```
    Saves all data in the cache to Database and closes the database down. Stops all tasks. If processTask has unprocessed information, it will be processed.
  - saveCachedData
```
public void saveCachedData(UUID uuid)
```
    Saves the cached data of matching Player if it is in the cache.
    
    Parameters:
    
    uuid - Player's UUID
  - saveCommandUse
```
public void saveCommandUse()
```
    Saves the cached CommandUse. Should be only called from an Asyncronous Thread.
  - saveHandlerDataToCache
```
public void saveHandlerDataToCache()
```
    Refreshes the calculations for all online players with ReloadInfo.
  - clearCache
```
public void clearCache()
```
    Schedules all UserData from the Cache to be cleared.
  - clearFromCache
```
public void clearFromCache(UUID uuid)
```
    Clears the matching UserData from the Cache if they're not online.
    
    Parameters:
    
    uuid - Player's UUID
  - scheludeForClear
```
public void scheludeForClear(UUID uuid)
```
    Schedules a matching UserData object to be cleared from the cache.
    
    Parameters:
    
    uuid - Player's UUID.
  - isDataAccessed
```
public boolean isDataAccessed(UUID uuid)
```
    Check whether or not the UserData object is being accessed by save or process tasks.
    
    Parameters:
    
    uuid - Player's UUID
    
    Returns:
    
    true/false
  - newPlayer
```
public void newPlayer(org.bukkit.entity.Player player)
```
    Creates a new UserData instance and saves it to the Database.
    
    Parameters:
    
    player - Player the new UserData is created for
  - newPlayer
```
public void newPlayer(org.bukkit.OfflinePlayer player)
```
    Creates a new UserData instance and saves it to the Database.
    
    Parameters:
    
    player - Player the new UserData is created for
  - newPlayer
```
public void newPlayer(UserData data)
```
    Schedules a new player's data to be saved to the Database.
    
    Parameters:
    
    data - UserData object to schedule for save.
  - getDataCache
```
public HashMap<UUID,UserData> getDataCache()
```
    Used to get the contents of the cache.
    
    Returns:
    
    The HashMap containing all Cached UserData
  - getCommandUse
```
public Map<String,Integer> getCommandUse()
```
    Used to get the cached commandUse.
    
    Returns:
    
    Map with key:value - "/command":4
  - handleReload
```
public void handleReload()
```
    If /reload is run this treats every online player as a new login. Calls all the methods that are ran when PlayerJoinEvent is fired
  - getMaxPlayers
```
public int getMaxPlayers()
```
    Used by Analysis for Player activity graphs.
    
    Returns:
    
    Maximum number of players defined in server.properties.
  - handleCommand
```
public void handleCommand(String command)
```
    Used to handle a command's execution.
    
    Parameters:
    
    command - "/command"

Class DataCacheHandler

Constructor Summary

Method Summary

Methods inherited from class main.java.com.djrapitops.plan.data.cache.LocationCache

Methods inherited from class main.java.com.djrapitops.plan.data.cache.SessionCache

Methods inherited from class java.lang.Object

Constructor Detail

DataCacheHandler

Method Detail

getCommandUseFromDb

startQueues

startAsyncPeriodicSaveTask

getUserDataForProcessing

cache

getUserDataForProcessing

saveCachedUserData

addToPool

saveCacheOnDisable

saveCachedData

saveCommandUse

saveHandlerDataToCache

clearCache

clearFromCache

scheludeForClear

isDataAccessed

newPlayer

newPlayer

newPlayer

getDataCache

getCommandUse

handleReload

getMaxPlayers

handleCommand