Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2025-01-08 09:27:45 +01:00
Code Issues Projects Releases Wiki Activity
7415a5e1b1
Plan/all/com/djrapitops/plan/system/webserver/cache/ResponseCache.html

382 lines
16 KiB
HTML
Raw Normal View History

Updated javadocs
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>
Updated javadocs
2019-08-21 11:10:29 +02:00
<!-- Generated by javadoc (1.8.0_201) on Wed Aug 21 12:09:03 EEST 2019 -->
<title>ResponseCache (Plan 4.9.4 API)</title>
<meta name="date" content="2019-08-21">
Updated javadocs
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) {
Updated javadocs
2019-08-21 11:10:29 +02:00
parent.document.title="ResponseCache (Plan 4.9.4 API)";
Updated javadocs
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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">
<li><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/PageId.html" title="enum in com.djrapitops.plan.system.webserver.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/system/webserver/cache/ResponseCache.html" target="_top">Frames</a></li>
<li><a href="ResponseCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">
<div class="subTitle">com.djrapitops.plan.system.webserver.cache</div>
<h2 title="Class ResponseCache" class="title">Class ResponseCache</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.system.webserver.cache.ResponseCache</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ResponseCache</span>
extends java.lang.Object</pre>
<div class="block">This class contains the page cache.
<p>
It caches all Responses with their matching identifiers.
This reduces CPU cycles and the time to wait for loading the pages.
This is especially useful in situations where multiple clients are accessing the server.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#cacheResponse-java.lang.String-java.util.function.Supplier-">cacheResponse</a></span>(java.lang.String&nbsp;identifier,
java.util.function.Supplier&lt;<a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a>&gt;&nbsp;loader)</code>
<div class="block">Puts the page into the page cache.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#clearCache--">clearCache</a></span>()</code>
<div class="block">Clears the cache from all its contents.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#clearResponse-java.lang.String-">clearResponse</a></span>(java.lang.String&nbsp;identifier)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#getCacheKeys--">getCacheKeys</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#getEstimatedSize--">getEstimatedSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#isCached-java.lang.String-">isCached</a></span>(java.lang.String&nbsp;identifier)</code>
<div class="block">Checks if the page is cached.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#loadResponse-java.lang.String-">loadResponse</a></span>(java.lang.String&nbsp;identifier)</code>
<div class="block">Loads the page from the page cache.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/ResponseCache.html#loadResponse-java.lang.String-java.util.function.Supplier-">loadResponse</a></span>(java.lang.String&nbsp;identifier,
java.util.function.Supplier&lt;<a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a>&gt;&nbsp;loader)</code>
<div class="block">Loads the response from the response cache.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="loadResponse-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadResponse</h4>
<pre>public static&nbsp;<a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a>&nbsp;loadResponse(java.lang.String&nbsp;identifier,
java.util.function.Supplier&lt;<a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a>&gt;&nbsp;loader)</pre>
<div class="block">Loads the response from the response cache.
<p>
If the <a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response"><code>Response</code></a> isn't cached, <code>Supplier.get()</code> in the <code>loader</code>
is called to create the Response.
<p>
If the Response is created, it's automatically cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - The identifier of the page</dd>
<dd><code>loader</code> - The The <a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response"><code>Response</code></a> <code>Supplier</code> (How should it load the page if it's not cached)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Response that was cached or created by the the <a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response"><code>Response</code></a> <code>Supplier</code></dd>
</dl>
</li>
</ul>
<a name="loadResponse-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadResponse</h4>
<pre>public static&nbsp;<a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a>&nbsp;loadResponse(java.lang.String&nbsp;identifier)</pre>
<div class="block">Loads the page from the page cache.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - The identifier of the page</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Response that was cached or <code>null</code> if it wasn't</dd>
</dl>
</li>
</ul>
<a name="cacheResponse-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheResponse</h4>
<pre>public static&nbsp;void&nbsp;cacheResponse(java.lang.String&nbsp;identifier,
java.util.function.Supplier&lt;<a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response">Response</a>&gt;&nbsp;loader)</pre>
<div class="block">Puts the page into the page cache.
<p>
If the cache already inherits that <code>identifier</code>, it's renewed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - The identifier of the page</dd>
<dd><code>loader</code> - The <a href="../../../../../../com/djrapitops/plan/system/webserver/response/Response.html" title="class in com.djrapitops.plan.system.webserver.response"><code>Response</code></a> <code>Supplier</code> (How it should load the page)</dd>
</dl>
</li>
</ul>
<a name="isCached-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCached</h4>
<pre>public static&nbsp;boolean&nbsp;isCached(java.lang.String&nbsp;identifier)</pre>
<div class="block">Checks if the page is cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - The identifier of the page</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the page is cached</dd>
</dl>
</li>
</ul>
<a name="clearCache--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearCache</h4>
<pre>public static&nbsp;void&nbsp;clearCache()</pre>
<div class="block">Clears the cache from all its contents.</div>
</li>
</ul>
<a name="getCacheKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheKeys</h4>
<pre>public static&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getCacheKeys()</pre>
</li>
</ul>
<a name="getEstimatedSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimatedSize</h4>
<pre>public static&nbsp;long&nbsp;getEstimatedSize()</pre>
</li>
</ul>
<a name="clearResponse-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clearResponse</h4>
<pre>public static&nbsp;void&nbsp;clearResponse(java.lang.String&nbsp;identifier)</pre>
</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">
<li><a href="../../../../../../com/djrapitops/plan/system/webserver/cache/PageId.html" title="enum in com.djrapitops.plan.system.webserver.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/djrapitops/plan/system/webserver/cache/ResponseCache.html" target="_top">Frames</a></li>
<li><a href="ResponseCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink