UserData (Plan 3.1.1 API)

java.lang.Object
- main.java.com.djrapitops.plan.data.UserData

```
public class UserData
extends Object
```
This class is used for storing information about a player during runtime.

Author:

Rsl1122

Constructor Summary

Constructors
Constructor and Description
`UserData(org.bukkit.OfflinePlayer player, DemographicsData demData)` Creates a new UserData object with the variables inside a OfflinePlayer object.
`UserData(org.bukkit.entity.Player player, DemographicsData demData)` Creates a new UserData object with the variables inside a Player object.
`UserData(UserData data)` Creates a new UserData object with copied values.
`UserData(UUID uuid, long reg, org.bukkit.Location loc, boolean op, org.bukkit.GameMode lastGM, DemographicsData demData, String name, boolean online)` Creates a new UserData object with given values and default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`access()` Accesses the UserData object to protect it from being cleared.
`void`	`addIpAddress(InetAddress ip)` Adds an to the ips Set if it is not null or the set doesn't contain it.
`void`	`addIpAddresses(Collection<InetAddress> addIps)` Adds multiple ips to the ips set if they're not null.
`void`	`addLocation(org.bukkit.Location loc)` Adds a location to the locations list.
`void`	`addLocations(Collection<org.bukkit.Location> addLocs)` Adds multiple locations to the locations list.
`boolean`	`addNickname(String nick)` Adds a nickname to the nicknames Set.
`void`	`addNicknames(Collection<String> addNicks)` Adds nicknames to the nicknames Set.
`void`	`addPlayerKill(KillData kill)` Add a Killdata to player's kills list.
`void`	`addSession(SessionData session)` Adds a new SessionData to the sessions list.
`void`	`addSessions(Collection<SessionData> sessions)` Adds SessionData objects to the sessions list.
`boolean`	`equals(Object obj)`
`SessionData`	`getCurrentSession()` Gets the current session.
`int`	`getDeaths()` Get how many times the player has died.
`DemographicsData`	`getDemData()` Get the DemographicsData of the user.
`Map<org.bukkit.GameMode,Long>`	`getGmTimes()` Get the GMTimes Map.
`Set<InetAddress>`	`getIps()` Get the InetAddress Set.
`org.bukkit.GameMode`	`getLastGamemode()` Get the last Gamemode that the user was seen in.
`long`	`getLastGmSwapTime()` Get the last time a Gamemode time was updated.
`String`	`getLastNick()` Get the last nickname the user has set.
`long`	`getLastPlayed()` Get the Epoch millisecond the player was last seen.
`org.bukkit.Location`	`getLocation()` Used to get the latest location.
`List<org.bukkit.Location>`	`getLocations()` Get the list of all locations inside the UserData object.
`int`	`getLoginTimes()` Get how many times the player has logged in.
`int`	`getMobKills()` Get how many mob kills the player has.
`String`	`getName()` Get the username of the player.
`Set<String>`	`getNicknames()` Get the nickname String Set.
`List<KillData>`	`getPlayerKills()` Get the player kills list.
`long`	`getPlayTime()` Get the playtime in milliseconds.
`long`	`getRegistered()` Get the Epoch millisecond the player registered.
`List<SessionData>`	`getSessions()` Get the sessions of a player.
`int`	`getTimesKicked()` Get how many times the player has been kicked.
`UUID`	`getUuid()` Used to get the UUID of the player.
`boolean`	`isAccessed()` Checks whether or not the UserData object is accessed by different save processes.
`boolean`	`isBanned()` Is the user Banned?
`boolean`	`isOnline()` Is the player online?
`boolean`	`isOp()` Is the user Operator?
`void`	`setAllGMTimes(long survivalTime, long creativeTime, long adventureTime, long spectatorTime)` Set every GameMode's millisecond value.
`void`	`setClearAfterSave(boolean clearAfterSave)` Set wether or not the object should be cleared from cache after it has been saved.
`void`	`setCurrentSession(SessionData session)` Sets the current session.
`void`	`setDeaths(int deaths)` Set how many times the player has died.
`void`	`setDemData(DemographicsData demData)` Set the DemographicsData of the user.
`void`	`setGMTime(org.bukkit.GameMode gm, long time)` Set a specific GameMode's millisecond value.
`void`	`setGmTimes(Map<org.bukkit.GameMode,Long> gmTimes)` Set the GM Times map containing playtime in each gamemode.
`void`	`setIps(Set<InetAddress> ips)` Set the ips set.
`void`	`setIsOp(boolean isOp)` Set whether or not player is op.
`void`	`setLastGamemode(org.bukkit.GameMode lastGamemode)` Set the last gamemode the user was seen in.
`void`	`setLastGmSwapTime(long lastGmSwapTime)` Set the last time a Gamemode time was updated.
`void`	`setLastNick(String lastNick)` Set the last nickname the user has set.
`void`	`setLastPlayed(long lastPlayed)` Set the time the user was last seen.
`void`	`setLocation(org.bukkit.Location location)` Set the current location.
`void`	`setLocations(List<org.bukkit.Location> locations)` Set the list of locations the user has been in.
`void`	`setLoginTimes(int loginTimes)` Set how many times the user has logged in.
`void`	`setMobKills(int mobKills)` Get how many mob kills the player has.
`void`	`setName(String name)` Set the username of the user.
`void`	`setNicknames(Set<String> nicknames)` Set the nicknames set.
`void`	`setPlayerKills(List<KillData> playerKills)` Set the playerkills list.
`void`	`setPlayTime(long playTime)` Set the time the user has been playing.
`void`	`setRegistered(long registered)` Set the time the user was registered.
`void`	`setTimesKicked(int timesKicked)` Set how many times the user has been kicked.
`void`	`setUuid(UUID uuid)` Set the UUID.
`boolean`	`shouldClearAfterSave()` Check wether or not the object should be cleared from cache after it has been saved.
`void`	`stopAccessing()` Stops accessing the object so that it can now be cleared.
`String`	`toString()`
`void`	`updateBanned(boolean isBanned)` Changes the value of isBanned.

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

- Constructor Detail
  - UserData
```
public UserData(UUID uuid,
                long reg,
                org.bukkit.Location loc,
                boolean op,
                org.bukkit.GameMode lastGM,
                DemographicsData demData,
                String name,
                boolean online)
```
    Creates a new UserData object with given values and default values. Some variables are left uninitialized: isBanned, lastPlayed, playTime, loginTimes, timesKicked, lastGmSwapTime, mobKills, deaths and currentSession. These variables need to be set with setters. All Collections are left empty: locations, nicknames, ips, sessions, playerKills. Because nicknames is empty, lastNick is an empty string. gmTimes Hashmap will contain 4 '0L' values: SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR
    
    Parameters:
    
    uuid - UUID of the player
    
    reg - Epoch millisecond the player registered.
    
    loc - Current Location in a world.
    
    op - Is the player op? (true/false)
    
    lastGM - last GameMode the player was seen in.
    
    demData - Demographics data.
    
    name - Name of the player.
    
    online - Is the player online?
  - UserData
```
public UserData(org.bukkit.entity.Player player,
                DemographicsData demData)
```
    Creates a new UserData object with the variables inside a Player object. Some variables are left uninitialized: lastPlayed, playTime, loginTimes, timesKicked, lastGmSwapTime, mobKills, deaths and currentSession. These variables need to be set with setters. All Collections are left empty: locations, nicknames, ips, sessions, playerKills. Because nicknames is empty, lastNick is an empty string. gmTimes Hashmap will contain 4 '0L' values: SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR
    
    Parameters:
    
    player - Player object.
    
    demData - Demographics data.
  - UserData
```
public UserData(org.bukkit.OfflinePlayer player,
                DemographicsData demData)
```
    Creates a new UserData object with the variables inside a OfflinePlayer object. Some variables are left uninitialized: location, lastPlayed, playTime, loginTimes, timesKicked, lastGmSwapTime, mobKills, deaths and currentSession. These variables need to be set with setters. All Collections are left empty: locations, nicknames, ips, sessions, playerKills. Because nicknames is empty, lastNick is an empty string. gmTimes Hashmap will contain 4 '0L' values: SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR lastGM will be set as SURVIVAL
    
    Parameters:
    
    player - OfflinePlayer object.
    
    demData - Demographics data.
  - UserData
```
public UserData(UserData data)
```
    Creates a new UserData object with copied values.
    
    Parameters:
    
    data - UserData to copy into the new object.
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addIpAddress
```
public void addIpAddress(InetAddress ip)
```
    Adds an to the ips Set if it is not null or the set doesn't contain it.
    
    Parameters:
    
    ip - InetAddress of the player.
  - addIpAddresses
```
public void addIpAddresses(Collection<InetAddress> addIps)
```
    Adds multiple ips to the ips set if they're not null.
    
    Parameters:
    
    addIps - a Collection of InetAddresses the player has logged from.
  - addLocation
```
public void addLocation(org.bukkit.Location loc)
```
    Adds a location to the locations list. null value filtered. loc will be set as the latest location.
    
    Parameters:
    
    loc - Location of the player.
  - addLocations
```
public void addLocations(Collection<org.bukkit.Location> addLocs)
```
    Adds multiple locations to the locations list. null value filtered.
    
    Parameters:
    
    addLocs - Collection of Locations.
  - addNickname
```
public boolean addNickname(String nick)
```
    Adds a nickname to the nicknames Set. null or empty values filtered. lastNick will be set as the given parameter, if accepted.
    
    Parameters:
    
    nick - Displayname of the player.
    
    Returns:
    
    was lastNick updated?
  - addNicknames
```
public void addNicknames(Collection<String> addNicks)
```
    Adds nicknames to the nicknames Set. null or empty values filtered.
    
    Parameters:
    
    addNicks - Collection of nicknames.
  - setGMTime
```
public void setGMTime(org.bukkit.GameMode gm,
                      long time)
```
    Set a specific GameMode's millisecond value.
    
    Parameters:
    
    gm - GameMode.
    
    time - Milliseconds spent in the gamemode.
  - setAllGMTimes
```
public void setAllGMTimes(long survivalTime,
                          long creativeTime,
                          long adventureTime,
                          long spectatorTime)
```
    Set every GameMode's millisecond value.
    
    Parameters:
    
    survivalTime - ms spent in SURVIVAL
    
    creativeTime - ms spent in CREATIVE
    
    adventureTime - ms spent in ADVENTURE
    
    spectatorTime - ms spent in SPECTATOR
  - addSession
```
public void addSession(SessionData session)
```
    Adds a new SessionData to the sessions list. null and invalid sessions filtered.
    
    Parameters:
    
    session - SessionData object
  - addSessions
```
public void addSessions(Collection<SessionData> sessions)
```
    Adds SessionData objects to the sessions list. null and invalid sessions filtered.
    
    Parameters:
    
    sessions - Collection of SessionData objects.
  - setCurrentSession
```
public void setCurrentSession(SessionData session)
```
    Sets the current session. Currently unused.
    
    Parameters:
    
    session - SessionData object, no restrictions.
  - getCurrentSession
```
public SessionData getCurrentSession()
```
    Gets the current session. Currently unused.
    
    Returns:
    
    SessionData object with a recent start.
  - updateBanned
```
public void updateBanned(boolean isBanned)
```
    Changes the value of isBanned.
    
    Parameters:
    
    isBanned - Is the player banned?
  - isAccessed
```
public boolean isAccessed()
```
    Checks whether or not the UserData object is accessed by different save processes.
    
    Returns:
    
    true if accessed.
  - access
```
public void access()
```
    Accesses the UserData object to protect it from being cleared.
  - stopAccessing
```
public void stopAccessing()
```
    Stops accessing the object so that it can now be cleared.
  - getUuid
```
public UUID getUuid()
```
    Used to get the UUID of the player.
    
    Returns:
    
    UUID.
  - getLocation
```
public org.bukkit.Location getLocation()
```
    Used to get the latest location. NOT INITIALIZED BY CONSTRUCTORS
    
    Returns:
    
    Location.
  - getLocations
```
public List<org.bukkit.Location> getLocations()
```
    Get the list of all locations inside the UserData object.
    
    Returns:
    
    a list of Locations.
  - getIps
```
public Set<InetAddress> getIps()
```
    Get the InetAddress Set.
    
    Returns:
    
    a HashSet of ips.
  - getNicknames
```
public Set<String> getNicknames()
```
    Get the nickname String Set.
    
    Returns:
    
    a HashSet of Strings.
  - getRegistered
```
public long getRegistered()
```
    Get the Epoch millisecond the player registered.
    
    Returns:
    
    long in ms.
  - getLastPlayed
```
public long getLastPlayed()
```
    Get the Epoch millisecond the player was last seen. NOT INITIALIZED BY CONSTRUCTORS. Value is updated periodically by cache if the player is online.
    
    Returns:
    
    long in ms.
  - getPlayTime
```
public long getPlayTime()
```
    Get the playtime in milliseconds. NOT INITIALIZED BY CONSTRUCTORS. Value is updated periodically by cache if the player is online.
    
    Returns:
    
    time in ms.
  - getLoginTimes
```
public int getLoginTimes()
```
    Get how many times the player has logged in. NOT INITIALIZED BY CONSTRUCTORS.
    
    Returns:
    
    0 to Integer.MAX
  - getTimesKicked
```
public int getTimesKicked()
```
    Get how many times the player has been kicked. NOT INITIALIZED BY CONSTRUCTORS.
    
    Returns:
    
    0 to Integer.MAX
  - getGmTimes
```
public Map<org.bukkit.GameMode,Long> getGmTimes()
```
    Get the GMTimes Map.
    
    Returns:
    
    a GameMode map with 4 keys: SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR.
  - getLastGmSwapTime
```
public long getLastGmSwapTime()
```
    Get the last time a Gamemode time was updated.
    
    Returns:
    
    Epoch millisecond of last GM Time update.
  - getLastGamemode
```
public org.bukkit.GameMode getLastGamemode()
```
    Get the last Gamemode that the user was seen in. When player changes to SURVIVAL this is set to SURVIVAL.
    
    Returns:
    
    Gamemode.
  - isOp
```
public boolean isOp()
```
    Is the user Operator?
    
    Returns:
    
    opped?
  - isBanned
```
public boolean isBanned()
```
    Is the user Banned?
    
    Returns:
    
    banned?
  - getDemData
```
public DemographicsData getDemData()
```
    Get the DemographicsData of the user.
    
    Returns:
    
    Demographics data.
  - getName
```
public String getName()
```
    Get the username of the player.
    
    Returns:
    
    username.
  - setUuid
```
public void setUuid(UUID uuid)
```
    Set the UUID.
    
    Parameters:
    
    uuid - UUID
  - setLocation
```
public void setLocation(org.bukkit.Location location)
```
    Set the current location. Not in use.
    
    Parameters:
    
    location - a location in the world.
  - setLocations
```
public void setLocations(List<org.bukkit.Location> locations)
```
    Set the list of locations the user has been in. Not in use.
    
    Parameters:
    
    locations - a list of Locations.
  - setIps
```
public void setIps(Set<InetAddress> ips)
```
    Set the ips set.
    
    Parameters:
    
    ips - ips of the user.
  - setNicknames
```
public void setNicknames(Set<String> nicknames)
```
    Set the nicknames set.
    
    Parameters:
    
    nicknames - nicknames of the user.
  - setRegistered
```
public void setRegistered(long registered)
```
    Set the time the user was registered.
    
    Parameters:
    
    registered - Epoch millisecond of register time.
  - setLastPlayed
```
public void setLastPlayed(long lastPlayed)
```
    Set the time the user was last seen. Affects playtime calculation, playtime should be updated before updating this value.
    
    Parameters:
    
    lastPlayed - Epoch millisecond of last seen moment.
  - setPlayTime
```
public void setPlayTime(long playTime)
```
    Set the time the user has been playing.
    
    Parameters:
    
    playTime - Time in ms.
  - setLoginTimes
```
public void setLoginTimes(int loginTimes)
```
    Set how many times the user has logged in. No check for input.
    
    Parameters:
    
    loginTimes - 0 to Int.MAX
  - setTimesKicked
```
public void setTimesKicked(int timesKicked)
```
    Set how many times the user has been kicked. No check for input.
    
    Parameters:
    
    timesKicked - 0 to Int.MAX
  - setGmTimes
```
public void setGmTimes(Map<org.bukkit.GameMode,Long> gmTimes)
```
    Set the GM Times map containing playtime in each gamemode.
    
    Parameters:
    
    gmTimes - Map containing SURVIVAL, CREATIVE, ADVENTURE and SPECTATOR (After 1.8) keys.
  - setLastGmSwapTime
```
public void setLastGmSwapTime(long lastGmSwapTime)
```
    Set the last time a Gamemode time was updated.
    
    Parameters:
    
    lastGmSwapTime - Epoch millisecond a gm time was updated.
  - setLastGamemode
```
public void setLastGamemode(org.bukkit.GameMode lastGamemode)
```
    Set the last gamemode the user was seen in.
    
    Parameters:
    
    lastGamemode - gamemode.
  - setIsOp
```
public void setIsOp(boolean isOp)
```
    Set whether or not player is op.
    
    Parameters:
    
    isOp - operator?
  - setDemData
```
public void setDemData(DemographicsData demData)
```
    Set the DemographicsData of the user.
    
    Parameters:
    
    demData - demographics data.
  - setName
```
public void setName(String name)
```
    Set the username of the user.
    
    Parameters:
    
    name - username.
  - isOnline
```
public boolean isOnline()
```
    Is the player online?
    
    Returns:
    
    true if data is cached to datacache, false if not.
  - getMobKills
```
public int getMobKills()
```
    Get how many mob kills the player has.
    
    Returns:
    
    0 to Int.MAX
  - setMobKills
```
public void setMobKills(int mobKills)
```
    Get how many mob kills the player has.
    
    Parameters:
    
    mobKills - 0 to Int.MAX
  - getPlayerKills
```
public List<KillData> getPlayerKills()
```
    Get the player kills list.
    
    Returns:
    
    playerkills list.
  - setPlayerKills
```
public void setPlayerKills(List<KillData> playerKills)
```
    Set the playerkills list.
    
    Parameters:
    
    playerKills - list of players kills.
  - addPlayerKill
```
public void addPlayerKill(KillData kill)
```
    Add a Killdata to player's kills list.
    
    Parameters:
    
    kill - KillData representing a player kill.
  - getDeaths
```
public int getDeaths()
```
    Get how many times the player has died.
    
    Returns:
    
    0 to Int.MAX
  - setDeaths
```
public void setDeaths(int deaths)
```
    Set how many times the player has died.
    
    Parameters:
    
    deaths - 0 to Int.MAX
  - getSessions
```
public List<SessionData> getSessions()
```
    Get the sessions of a player.
    
    Returns:
    
    a list of SessionData.
  - getLastNick
```
public String getLastNick()
```
    Get the last nickname the user has set. Set when using addNickname(String)
    
    Returns:
    
    last nickname used.
  - setLastNick
```
public void setLastNick(String lastNick)
```
    Set the last nickname the user has set. Also set when using addNickname(String)
    
    Parameters:
    
    lastNick - last nickname used.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - shouldClearAfterSave
```
public boolean shouldClearAfterSave()
```
    Check wether or not the object should be cleared from cache after it has been saved.
    
    Returns:
    
    true/false
  - setClearAfterSave
```
public void setClearAfterSave(boolean clearAfterSave)
```
    Set wether or not the object should be cleared from cache after it has been saved.
    
    Parameters:
    
    clearAfterSave - true/false

Class UserData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserData

UserData

UserData

UserData

Method Detail

toString

addIpAddress

addIpAddresses

addLocation

addLocations

addNickname

addNicknames

setGMTime

setAllGMTimes

addSession

addSessions

setCurrentSession

getCurrentSession

updateBanned

isAccessed

access

stopAccessing

getUuid

getLocation

getLocations

getIps

getNicknames

getRegistered

getLastPlayed

getPlayTime

getLoginTimes

getTimesKicked

getGmTimes

getLastGmSwapTime

getLastGamemode

isOp

isBanned

getDemData

getName

setUuid

setLocation

setLocations

setIps

setNicknames

setRegistered

setLastPlayed

setPlayTime

setLoginTimes

setTimesKicked

setGmTimes

setLastGmSwapTime

setLastGamemode

setIsOp

setDemData

setName

isOnline

getMobKills

setMobKills

getPlayerKills

setPlayerKills

addPlayerKill

getDeaths

setDeaths

getSessions

getLastNick

setLastNick

equals

shouldClearAfterSave

setClearAfterSave