Plan/docs/main/java/com/djrapitops/plan/systems/webserver/PageCache.html
2017-10-02 21:53:35 +03:00

375 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 02 21:49:47 EEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PageCache (Plan 4.0.0 API)</title>
<meta name="date" content="2017-10-02">
<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) {
parent.document.title="PageCache (Plan 4.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":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="class-use/PageCache.html">Use</a></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="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/APIResponseHandler.html" title="class in main.java.com.djrapitops.plan.systems.webserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/systems/webserver/PageCache.html" target="_top">Frames</a></li>
<li><a href="PageCache.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">main.java.com.djrapitops.plan.systems.webserver</div>
<h2 title="Class PageCache" class="title">Class PageCache</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>main.java.com.djrapitops.plan.systems.webserver.PageCache</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PageCache</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></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.
<p>
This cache uses the Google Guava <code>Cache</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.6.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Fuzzlemann</dd>
</dl>
</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="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageCache.html#cachePage-java.lang.String-main.java.com.djrapitops.plan.systems.webserver.PageLoader-">cachePage</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;identifier,
<a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver">PageLoader</a>&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="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageCache.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 boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageCache.html#isCached-java.lang.String-">isCached</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;identifier)</code>
<div class="block">Checks if the page is cached.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/response/Response.html" title="class in main.java.com.djrapitops.plan.systems.webserver.response">Response</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageCache.html#loadPage-java.lang.String-">loadPage</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;identifier)</code>
<div class="block">Loads the page from the page cache.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/response/Response.html" title="class in main.java.com.djrapitops.plan.systems.webserver.response">Response</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageCache.html#loadPage-java.lang.String-main.java.com.djrapitops.plan.systems.webserver.PageLoader-">loadPage</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;identifier,
<a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver">PageLoader</a>&nbsp;loader)</code>
<div class="block">Loads the page from the page cache.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageCache.html#removeIf-java.util.function.Predicate-">removeIf</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;filter)</code>
<div class="block">Removes all of the elements of this cache that satisfy the given predicate.</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.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="loadPage-java.lang.String-main.java.com.djrapitops.plan.systems.webserver.PageLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPage</h4>
<pre>public static&nbsp;<a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/response/Response.html" title="class in main.java.com.djrapitops.plan.systems.webserver.response">Response</a>&nbsp;loadPage(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;identifier,
<a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver">PageLoader</a>&nbsp;loader)</pre>
<div class="block">Loads the page from the page cache.
<p>
If the <a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/response/Response.html" title="class in main.java.com.djrapitops.plan.systems.webserver.response"><code>Response</code></a> isn't cached, <a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html#createResponse--"><code>PageLoader.createResponse()</code></a> 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 <a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver"><code>PageLoader</code></a> (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 <a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver"><code>loader</code></a></dd>
</dl>
</li>
</ul>
<a name="loadPage-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPage</h4>
<pre>public static&nbsp;<a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/response/Response.html" title="class in main.java.com.djrapitops.plan.systems.webserver.response">Response</a>&nbsp;loadPage(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&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="cachePage-java.lang.String-main.java.com.djrapitops.plan.systems.webserver.PageLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cachePage</h4>
<pre>public static&nbsp;void&nbsp;cachePage(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;identifier,
<a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver">PageLoader</a>&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="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver"><code>PageLoader</code></a> (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(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&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="removeIf-java.util.function.Predicate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeIf</h4>
<pre>public static&nbsp;void&nbsp;removeIf(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;filter)</pre>
<div class="block">Removes all of the elements of this cache that satisfy the given predicate.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - a predicate which returns true for entries to be removed</dd>
</dl>
</li>
</ul>
<a name="clearCache--">
<!-- -->
</a>
<ul class="blockListLast">
<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>
</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="class-use/PageCache.html">Use</a></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="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/APIResponseHandler.html" title="class in main.java.com.djrapitops.plan.systems.webserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../main/java/com/djrapitops/plan/systems/webserver/PageLoader.html" title="interface in main.java.com.djrapitops.plan.systems.webserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/systems/webserver/PageCache.html" target="_top">Frames</a></li>
<li><a href="PageCache.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
</body>
</html>