2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "fi" >
< head >
2020-01-24 11:56:15 +01:00
<!-- Generated by javadoc (1.8.0_201) on Fri Jan 24 12:56:11 EET 2020 -->
< title > SessionCache (Plan 5.0-SNAPSHOT API)< / title >
< meta name = "date" content = "2020-01-24" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
< script type = "text/javascript" src = "../../../../../script.js" > < / script >
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-01-24 11:56:15 +01:00
parent.document.title="SessionCache (Plan 5.0-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2019-10-05 10:27:37 +02:00
var methods = {"i0":10,"i1":9,"i2":10,"i3":9,"i4":9,"i5":9};
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "topNav" > < a name = "navbar.top" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a name = "navbar.top.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/gathering/cache/NicknameCache.html" title = "class in com.djrapitops.plan.gathering.cache" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< li > Next Class< / li >
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/gathering/cache/SessionCache.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "SessionCache.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.top" >
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
2019-10-05 10:27:37 +02:00
< div class = "subTitle" > com.djrapitops.plan.gathering.cache< / div >
2019-08-05 11:13:19 +02:00
< h2 title = "Class SessionCache" class = "title" > Class SessionCache< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
2019-10-05 10:27:37 +02:00
< li > com.djrapitops.plan.gathering.cache.SessionCache< / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< hr >
< br >
< pre > @Singleton
public class < span class = "typeNameLabel" > SessionCache< / span >
extends java.lang.Object< / pre >
< div class = "block" > This class is used to store active sessions of players in memory.< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor.summary" >
<!-- -->
< / a >
< h3 > Constructor Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Constructor Summary table, listing constructors, and an explanation" >
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colOne" scope = "col" > Constructor and Description< / th >
< / tr >
< tr class = "altColor" >
2019-10-05 10:27:37 +02:00
< td class = "colOne" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/gathering/cache/SessionCache.html#SessionCache--" > SessionCache< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< / table >
< / li >
< / ul >
<!-- ========== METHOD SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.summary" >
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Method Summary table, listing methods, and an explanation" >
< caption > < span id = "t0" class = "activeTableTab" > < span > All Methods< / span > < span class = "tabEnd" > < / span > < / span > < span id = "t1" class = "tableTab" > < span > < a href = "javascript:show(1);" > Static Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t2" class = "tableTab" > < span > < a href = "javascript:show(2);" > Instance Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t4" class = "tableTab" > < span > < a href = "javascript:show(8);" > Concrete Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Method and Description< / th >
< / tr >
< tr id = "i0" class = "altColor" >
2019-10-05 10:27:37 +02:00
< td class = "colFirst" > < code > java.util.Optional< < a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/gathering/cache/SessionCache.html#cacheSession-java.util.UUID-com.djrapitops.plan.gathering.domain.Session-" > cacheSession< / a > < / span > (java.util.UUID playerUUID,
< a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > session)< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Cache a new session.< / div >
< / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > static void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/gathering/cache/SessionCache.html#clear--" > clear< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i2" class = "altColor" >
2019-10-05 10:27:37 +02:00
< td class = "colFirst" > < code > java.util.Optional< < a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/gathering/cache/SessionCache.html#endSession-java.util.UUID-long-" > endSession< / a > < / span > (java.util.UUID playerUUID,
2019-08-05 11:13:19 +02:00
long time)< / code >
< div class = "block" > End a session and save it to database.< / div >
< / td >
< / tr >
< tr id = "i3" class = "rowColor" >
2019-10-05 10:27:37 +02:00
< td class = "colFirst" > < code > static java.util.Map< java.util.UUID,< a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/gathering/cache/SessionCache.html#getActiveSessions--" > getActiveSessions< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i4" class = "altColor" >
2019-10-05 10:27:37 +02:00
< td class = "colFirst" > < code > static java.util.Optional< < a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/gathering/cache/SessionCache.html#getCachedSession-java.util.UUID-" > getCachedSession< / a > < / span > (java.util.UUID playerUUID)< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Used to get the Session of the player in the sessionCache.< / div >
< / td >
< / tr >
< tr id = "i5" class = "rowColor" >
< td class = "colFirst" > < code > static void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/gathering/cache/SessionCache.html#refreshActiveSessionsState--" > refreshActiveSessionsState< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< / table >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods.inherited.from.class.java.lang.Object" >
<!-- -->
< / a >
< h3 > Methods inherited from class java.lang.Object< / h3 >
< code > clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait< / code > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor.detail" >
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
< a name = "SessionCache--" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > SessionCache< / h4 >
< pre > @Inject
public SessionCache()< / pre >
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "getActiveSessions--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getActiveSessions< / h4 >
2019-10-05 10:27:37 +02:00
< pre > public static java.util.Map< java.util.UUID,< a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > getActiveSessions()< / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< a name = "clear--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > clear< / h4 >
< pre > public static void clear()< / pre >
< / li >
< / ul >
< a name = "refreshActiveSessionsState--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > refreshActiveSessionsState< / h4 >
< pre > public static void refreshActiveSessionsState()< / pre >
< / li >
< / ul >
< a name = "getCachedSession-java.util.UUID-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getCachedSession< / h4 >
2019-10-05 10:27:37 +02:00
< pre > public static java.util.Optional< < a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > getCachedSession(java.util.UUID playerUUID)< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Used to get the Session of the player in the sessionCache.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > playerUUID< / code > - UUID of the player.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Optional with the session inside it if found.< / dd >
< / dl >
< / li >
< / ul >
2019-10-05 10:27:37 +02:00
< a name = "cacheSession-java.util.UUID-com.djrapitops.plan.gathering.domain.Session-" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > cacheSession< / h4 >
2019-10-05 10:27:37 +02:00
< pre > public java.util.Optional< < a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > cacheSession(java.util.UUID playerUUID,
< a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > session)< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Cache a new session.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > playerUUID< / code > - UUID of the player< / dd >
< dd > < code > session< / code > - Session to cache.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Optional: previous session. Recipients of this object should decide if it needs to be saved.< / dd >
< / dl >
< / li >
< / ul >
< a name = "endSession-java.util.UUID-long-" >
<!-- -->
< / a >
2019-10-05 10:27:37 +02:00
< ul class = "blockListLast" >
2019-08-05 11:13:19 +02:00
< li class = "blockList" >
< h4 > endSession< / h4 >
2019-10-05 10:27:37 +02:00
< pre > public java.util.Optional< < a href = "../../../../../com/djrapitops/plan/gathering/domain/Session.html" title = "class in com.djrapitops.plan.gathering.domain" > Session< / a > > endSession(java.util.UUID playerUUID,
2019-08-05 11:13:19 +02:00
long time)< / pre >
< div class = "block" > End a session and save it to database.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > playerUUID< / code > - UUID of the player.< / dd >
< dd > < code > time< / code > - Time the session ended.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Optional: ended session. Recipients of this object should decide if it needs to be saved.< / dd >
< / dl >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< div class = "bottomNav" > < a name = "navbar.bottom" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a name = "navbar.bottom.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/gathering/cache/NicknameCache.html" title = "class in com.djrapitops.plan.gathering.cache" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< li > Next Class< / li >
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/gathering/cache/SessionCache.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "SessionCache.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
