Plan/all/com/djrapitops/plan/delivery/web/ResourceSvc.html

598 lines
28 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2020-03-21 15:43:05 +01:00
<!-- NewPage -->
<html lang="en">
2020-03-21 15:43:05 +01:00
<head>
<!-- Generated by javadoc -->
<title>ResourceSvc (Plan 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2020-03-21 15:43:05 +01:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
2020-03-21 15:43:05 +01:00
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
2020-03-21 15:43:05 +01:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ResourceSvc (Plan 5.2-SNAPSHOT API)";
2020-03-21 15:43:05 +01:00
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
2020-03-21 15:43:05 +01:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2020-03-21 15:43:05 +01:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2020-03-21 15:43:05 +01:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2020-03-21 15:43:05 +01:00
<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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
2020-03-21 15:43:05 +01:00
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-03-21 15:43:05 +01:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
2020-03-21 15:43:05 +01:00
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
2020-03-21 15:43:05 +01:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2020-03-21 15:43:05 +01:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2020-03-21 15:43:05 +01:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.delivery.web</a></div>
2020-03-21 15:43:05 +01:00
<h2 title="Class ResourceSvc" class="title">Class ResourceSvc</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.delivery.web.ResourceSvc</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ResourceService.html" title="interface in com.djrapitops.plan.delivery.web">ResourceService</a></code></dd>
2020-03-21 15:43:05 +01:00
</dl>
<hr>
<pre>@Singleton
public class <span class="typeNameLabel">ResourceSvc</span>
extends java.lang.Object
implements <a href="ResourceService.html" title="interface in com.djrapitops.plan.delivery.web">ResourceService</a></pre>
2020-03-21 15:43:05 +01:00
<div class="block">ResourceService implementation.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
2020-03-21 15:43:05 +01:00
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.com.djrapitops.plan.delivery.web.ResourceService">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.djrapitops.plan.delivery.web.<a href="ResourceService.html" title="interface in com.djrapitops.plan.delivery.web">ResourceService</a></h3>
<code><a href="ResourceService.Holder.html" title="class in com.djrapitops.plan.delivery.web">ResourceService.Holder</a>, <a href="ResourceService.Position.html" title="enum in com.djrapitops.plan.delivery.web">ResourceService.Position</a></code></li>
2020-03-21 15:43:05 +01:00
</ul>
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
2020-03-21 15:43:05 +01:00
<ul class="blockList">
<li class="blockList"><a id="field.summary">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
2020-03-21 15:43:05 +01:00
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
2020-03-21 15:43:05 +01:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set&lt;com.djrapitops.plan.delivery.web.ResourceSvc.Snippet&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#snippets">snippets</a></span></code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
</table>
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
2020-03-21 15:43:05 +01:00
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
2020-03-21 15:43:05 +01:00
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
2020-03-21 15:43:05 +01:00
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.djrapitops.plan.storage.file.PlanFiles,com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.settings.locale.Locale,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">ResourceSvc</a></span>&#8203;(<a href="../../storage/file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a>&nbsp;files,
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
net.playeranalytics.plugin.server.PluginLogger&nbsp;logger,
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
</table>
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2020-03-21 15:43:05 +01:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
2020-03-21 15:43:05 +01:00
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addScriptsToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">addScriptsToResource</a></span>&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
<a href="ResourceService.Position.html" title="enum in com.djrapitops.plan.delivery.web">ResourceService.Position</a>&nbsp;position,
java.lang.String...&nbsp;jsSrcs)</code></th>
<td class="colLast">
2020-03-21 15:43:05 +01:00
<div class="block">Add javascript to load in an existing html resource.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addStylesToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">addStylesToResource</a></span>&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
<a href="ResourceService.Position.html" title="enum in com.djrapitops.plan.delivery.web">ResourceService.Position</a>&nbsp;position,
java.lang.String...&nbsp;cssSrcs)</code></th>
<td class="colLast">
2020-03-21 15:43:05 +01:00
<div class="block">Add css to load in an existing html resource.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkParams(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String%5B%5D)">checkParams</a></span>&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
<a href="ResourceService.Position.html" title="enum in com.djrapitops.plan.delivery.web">ResourceService.Position</a>&nbsp;position,
java.lang.String[]&nbsp;jsSrcs)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkParams(java.lang.String,java.lang.String,java.util.function.Supplier)">checkParams</a></span>&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrWriteCustomized(java.lang.String,java.util.function.Supplier)">getOrWriteCustomized</a></span>&#8203;(java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResource(java.lang.String,java.lang.String,java.util.function.Supplier)">getResource</a></span>&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</code></th>
<td class="colLast">
2020-03-21 15:43:05 +01:00
<div class="block">Make one of your web resources customizable by user or Plan API.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTheResource(java.lang.String,java.lang.String,java.util.function.Supplier)">getTheResource</a></span>&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readCustomized(com.djrapitops.plan.storage.file.Resource)">readCustomized</a></span>&#8203;(<a href="../../storage/file/Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a>&nbsp;customizedResource)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register()">register</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeCustomized(java.lang.String,java.util.function.Supplier)">writeCustomized</a></span>&#8203;(java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2020-03-21 15:43:05 +01:00
<!-- -->
</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>
</section>
2020-03-21 15:43:05 +01:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
2020-03-21 15:43:05 +01:00
<ul class="blockList">
<li class="blockList"><a id="field.detail">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="snippets">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>snippets</h4>
<pre>public final&nbsp;java.util.Set&lt;com.djrapitops.plan.delivery.web.ResourceSvc.Snippet&gt; snippets</pre>
</li>
</ul>
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
2020-03-21 15:43:05 +01:00
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(com.djrapitops.plan.storage.file.PlanFiles,com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.settings.locale.Locale,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ResourceSvc</h4>
<pre>@Inject
public&nbsp;ResourceSvc&#8203;(<a href="../../storage/file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a>&nbsp;files,
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
net.playeranalytics.plugin.server.PluginLogger&nbsp;logger,
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</pre>
2020-03-21 15:43:05 +01:00
</li>
</ul>
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2020-03-21 15:43:05 +01:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="register()">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;register()</pre>
2020-03-21 15:43:05 +01:00
</li>
</ul>
<a id="getResource(java.lang.String,java.lang.String,java.util.function.Supplier)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResource</h4>
<pre class="methodSignature">public&nbsp;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&nbsp;getResource&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ResourceService.html#getResource(java.lang.String,java.lang.String,java.util.function.Supplier)">ResourceService</a></code></span></div>
2020-03-21 15:43:05 +01:00
<div class="block">Make one of your web resources customizable by user or Plan API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ResourceService.html#getResource(java.lang.String,java.lang.String,java.util.function.Supplier)">getResource</a></code>&nbsp;in interface&nbsp;<code><a href="ResourceService.html" title="interface in com.djrapitops.plan.delivery.web">ResourceService</a></code></dd>
2020-03-21 15:43:05 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pluginName</code> - Name of your plugin (for config purposes)</dd>
<dd><code>fileName</code> - Name of the file (for customization)</dd>
<dd><code>source</code> - Supplier to use to get the original resource, it is assumed that any text based files are encoded in UTF-8.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Resource of the customized file.</dd>
</dl>
</li>
</ul>
<a id="checkParams(java.lang.String,java.lang.String,java.util.function.Supplier)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkParams</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;checkParams&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</pre>
2020-03-21 15:43:05 +01:00
</li>
</ul>
<a id="getTheResource(java.lang.String,java.lang.String,java.util.function.Supplier)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTheResource</h4>
<pre class="methodSignature">public&nbsp;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&nbsp;getTheResource&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)</pre>
2020-03-21 15:43:05 +01:00
</li>
</ul>
<a id="getOrWriteCustomized(java.lang.String,java.util.function.Supplier)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrWriteCustomized</h4>
<pre class="methodSignature">public&nbsp;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&nbsp;getOrWriteCustomized&#8203;(java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)
2020-03-21 15:43:05 +01:00
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="readCustomized(com.djrapitops.plan.storage.file.Resource)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readCustomized</h4>
<pre class="methodSignature">public&nbsp;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&nbsp;readCustomized&#8203;(<a href="../../storage/file/Resource.html" title="interface in com.djrapitops.plan.storage.file">Resource</a>&nbsp;customizedResource)
2020-03-21 15:43:05 +01:00
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="writeCustomized(java.lang.String,java.util.function.Supplier)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeCustomized</h4>
<pre class="methodSignature">public&nbsp;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&nbsp;writeCustomized&#8203;(java.lang.String&nbsp;fileName,
java.util.function.Supplier&lt;<a href="resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&gt;&nbsp;source)
2020-03-21 15:43:05 +01:00
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="addScriptsToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addScriptsToResource</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addScriptsToResource&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
<a href="ResourceService.Position.html" title="enum in com.djrapitops.plan.delivery.web">ResourceService.Position</a>&nbsp;position,
2020-03-21 15:43:05 +01:00
java.lang.String...&nbsp;jsSrcs)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ResourceService.html#addScriptsToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">ResourceService</a></code></span></div>
2020-03-21 15:43:05 +01:00
<div class="block">Add javascript to load in an existing html resource.
<p>
Adds <code>&lt;script src="jsSrc"&gt;&lt;/script&gt;</code> or multiple to the resource.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ResourceService.html#addScriptsToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">addScriptsToResource</a></code>&nbsp;in interface&nbsp;<code><a href="ResourceService.html" title="interface in com.djrapitops.plan.delivery.web">ResourceService</a></code></dd>
2020-03-21 15:43:05 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pluginName</code> - Name of your plugin (for config purposes)</dd>
<dd><code>fileName</code> - Name of the .html file being modified</dd>
<dd><code>position</code> - Where to place the script tag on the page.</dd>
<dd><code>jsSrcs</code> - Source URLs.</dd>
</dl>
</li>
</ul>
<a id="checkParams(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String[])">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkParams</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;checkParams&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
<a href="ResourceService.Position.html" title="enum in com.djrapitops.plan.delivery.web">ResourceService.Position</a>&nbsp;position,
2020-03-21 15:43:05 +01:00
java.lang.String[]&nbsp;jsSrcs)</pre>
</li>
</ul>
<a id="addStylesToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addStylesToResource</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addStylesToResource&#8203;(java.lang.String&nbsp;pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String&nbsp;fileName,
<a href="ResourceService.Position.html" title="enum in com.djrapitops.plan.delivery.web">ResourceService.Position</a>&nbsp;position,
2020-03-21 15:43:05 +01:00
java.lang.String...&nbsp;cssSrcs)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ResourceService.html#addStylesToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">ResourceService</a></code></span></div>
2020-03-21 15:43:05 +01:00
<div class="block">Add css to load in an existing html resource.
<p>
Adds <code>&lt;link href="cssSrc" rel="stylesheet"&gt;&lt;/link&gt;</code> or multiple to the resource.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ResourceService.html#addStylesToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)">addStylesToResource</a></code>&nbsp;in interface&nbsp;<code><a href="ResourceService.html" title="interface in com.djrapitops.plan.delivery.web">ResourceService</a></code></dd>
2020-03-21 15:43:05 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pluginName</code> - Name of your plugin (for config purposes)</dd>
<dd><code>fileName</code> - Name of the .html file being modified</dd>
<dd><code>position</code> - Where to place the link tag on the page.</dd>
<dd><code>cssSrcs</code> - Source URLs.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
</li>
</ul>
</div>
</div>
</main>
2020-03-21 15:43:05 +01:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2020-03-21 15:43:05 +01:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2020-03-21 15:43:05 +01:00
<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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
2020-03-21 15:43:05 +01:00
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-03-21 15:43:05 +01:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
2020-03-21 15:43:05 +01:00
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
2020-03-21 15:43:05 +01:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2020-03-21 15:43:05 +01:00
</body>
</html>