Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-02 08:51:21 +01:00
Code Issues Projects Releases Wiki Activity
dd315e724f
Plan/all/com/djrapitops/plan/delivery/domain/container/DataContainer.html

532 lines
28 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
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>DataContainer (Plan 5.1-SNAPSHOT API)</title>
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
2020-03-21 15:43:05 +01:00
parent.document.title="DataContainer (Plan 5.1-SNAPSHOT API)";
Updated javadocs
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
Updated javadocs
2020-03-21 15:43:05 +01:00
var methods = {"i0":6,"i1":18,"i2":18,"i3":6,"i4":6,"i5":6,"i6":18,"i7":18,"i8":18,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6};
Updated javadocs
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/CachingSupplier.html" title="class in com.djrapitops.plan.delivery.domain.container"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DynamicDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../../index.html?com/djrapitops/plan/delivery/domain/container/DataContainer.html" target="_top">Frames</a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
<li><a href="DataContainer.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">
Updated javadocs
2019-10-05 10:27:37 +02:00
<div class="subTitle">com.djrapitops.plan.delivery.domain.container</div>
Updated javadocs
2019-08-05 11:13:19 +02:00
<h2 title="Interface DataContainer" class="title">Interface DataContainer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dd><a href="../../../../../../com/djrapitops/plan/data/store/containers/AnalysisContainer.html" title="class in com.djrapitops.plan.data.store.containers">AnalysisContainer</a>, <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DynamicDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">DynamicDataContainer</a>, <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/PlayerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">PlayerContainer</a>, <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/RawDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">RawDataContainer</a>, <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/ServerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">ServerContainer</a>, <a href="../../../../../../com/djrapitops/plan/gathering/domain/Session.html" title="class in com.djrapitops.plan.gathering.domain">Session</a>, <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/SupplierDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">SupplierDataContainer</a></dd>
Updated javadocs
2019-08-05 11:13:19 +02:00
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DataContainer</span></pre>
Updated javadocs
2019-10-05 10:27:37 +02:00
<div class="block">Interface for an object that can store arbitrary data referenced via <a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys"><code>Key</code></a> objects.
Updated javadocs
2019-08-05 11:13:19 +02:00
<p>
Implementations should mainly be concerned on how the data given to it is stored.
Retrieval has some details that should be followed.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>void</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#clear--">clear</a></span>()</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Clear the container of all data.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default &lt;T&gt;&nbsp;java.lang.String</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#getFormatted-com.djrapitops.plan.delivery.domain.keys.Key-com.djrapitops.plan.delivery.formatting.Formatter-">getFormatted</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
<a href="../../../../../../com/djrapitops/plan/delivery/formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a>&lt;java.util.Optional&lt;T&gt;&gt;&nbsp;formatter)</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get formatted Value identified by the Key.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default &lt;T&gt;&nbsp;java.lang.String</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#getFormattedUnsafe-com.djrapitops.plan.delivery.domain.keys.Key-com.djrapitops.plan.delivery.formatting.Formatter-">getFormattedUnsafe</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
<a href="../../../../../../com/djrapitops/plan/delivery/formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a>&lt;T&gt;&nbsp;formatter)</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get formatted Value identified by the Key, or throw an exception.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colFirst"><code>java.util.Map&lt;<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#getMap--">getMap</a></span>()</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Return a Key - Value Map of the data in the container.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#getUnsafe-com.djrapitops.plan.delivery.domain.keys.Key-">getUnsafe</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key)</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get data identified by the Key, or throw an exception.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;java.util.Optional&lt;T&gt;</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#getValue-com.djrapitops.plan.delivery.domain.keys.Key-">getValue</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key)</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get an Optional of the Value identified by the Key.</div>
</td>
</tr>
<tr id="i6" class="altColor">
Updated javadocs
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code>default java.util.List&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#handleList-java.util.List-">handleList</a></span>(java.util.List&lt;?&gt;&nbsp;list)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>default java.util.Map&lt;?,?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#handleMap-java.util.Map-">handleMap</a></span>(java.util.Map&lt;?,?&gt;&nbsp;map)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>default java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#mapToNormalMap--">mapToNormalMap</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
Updated javadocs
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>void</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#putAll-com.djrapitops.plan.delivery.domain.container.DataContainer-">putAll</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a>&nbsp;dataContainer)</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Place all values from given DataContainer into this container.</div>
</td>
</tr>
Updated javadocs
2020-03-21 15:43:05 +01:00
<tr id="i10" class="altColor">
Updated javadocs
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#putCachingSupplier-com.djrapitops.plan.delivery.domain.keys.Key-java.util.function.Supplier-">putCachingSupplier</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
Updated javadocs
2019-08-05 11:13:19 +02:00
java.util.function.Supplier&lt;T&gt;&nbsp;supplier)</code>
<div class="block">Place a caching data supplier inside the container.</div>
</td>
</tr>
Updated javadocs
2020-03-21 15:43:05 +01:00
<tr id="i11" class="rowColor">
Updated javadocs
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#putRawData-com.djrapitops.plan.delivery.domain.keys.Key-T-">putRawData</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
Updated javadocs
2019-08-05 11:13:19 +02:00
T&nbsp;obj)</code>
<div class="block">Place your data inside the container.</div>
</td>
</tr>
Updated javadocs
2020-03-21 15:43:05 +01:00
<tr id="i12" class="altColor">
Updated javadocs
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#putSupplier-com.djrapitops.plan.delivery.domain.keys.Key-java.util.function.Supplier-">putSupplier</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
Updated javadocs
2019-08-05 11:13:19 +02:00
java.util.function.Supplier&lt;T&gt;&nbsp;supplier)</code>
<div class="block">Place a data supplier inside the container.</div>
</td>
</tr>
Updated javadocs
2020-03-21 15:43:05 +01:00
<tr id="i13" class="rowColor">
Updated javadocs
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>&lt;T&gt;&nbsp;boolean</code></td>
Updated javadocs
2019-10-05 10:27:37 +02:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#supports-com.djrapitops.plan.delivery.domain.keys.Key-">supports</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key)</code>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Check if a Value with the given Key has been placed into the container.</div>
</td>
</tr>
</table>
</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>
Updated javadocs
2020-03-21 15:43:05 +01:00
<a name="mapToNormalMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mapToNormalMap</h4>
<pre>default&nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;mapToNormalMap()</pre>
</li>
</ul>
<a name="handleList-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleList</h4>
<pre>default&nbsp;java.util.List&lt;?&gt;&nbsp;handleList(java.util.List&lt;?&gt;&nbsp;list)</pre>
</li>
</ul>
<a name="handleMap-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleMap</h4>
<pre>default&nbsp;java.util.Map&lt;?,?&gt;&nbsp;handleMap(java.util.Map&lt;?,?&gt;&nbsp;map)</pre>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="putRawData-com.djrapitops.plan.delivery.domain.keys.Key-java.lang.Object-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
Updated javadocs
2019-10-05 10:27:37 +02:00
</a><a name="putRawData-com.djrapitops.plan.delivery.domain.keys.Key-T-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putRawData</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>&lt;T&gt;&nbsp;void&nbsp;putRawData(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
Updated javadocs
2019-08-05 11:13:19 +02:00
T&nbsp;obj)</pre>
<div class="block">Place your data inside the container.
<p>
What the container does with the object depends on the implementation.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key of type T that identifies the data and will be used later when the data needs to be fetched.</dd>
<dd><code>obj</code> - object to store</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="putSupplier-com.djrapitops.plan.delivery.domain.keys.Key-java.util.function.Supplier-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putSupplier</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>&lt;T&gt;&nbsp;void&nbsp;putSupplier(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
Updated javadocs
2019-08-05 11:13:19 +02:00
java.util.function.Supplier&lt;T&gt;&nbsp;supplier)</pre>
<div class="block">Place a data supplier inside the container.
<p>
What the container does with the supplier depends on the implementation.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key of type T that identifies the data and will be used later when the data needs to be fetched.</dd>
<dd><code>supplier</code> - Supplier to store</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="putCachingSupplier-com.djrapitops.plan.delivery.domain.keys.Key-java.util.function.Supplier-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putCachingSupplier</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>&lt;T&gt;&nbsp;void&nbsp;putCachingSupplier(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
Updated javadocs
2019-08-05 11:13:19 +02:00
java.util.function.Supplier&lt;T&gt;&nbsp;supplier)</pre>
<div class="block">Place a caching data supplier inside the container.
<p>
If the supplier is called the value is cached according to the implementation of the container.
What the container does with the supplier depends on the implementation.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key of type T that identifies the data and will be used later when the data needs to be fetched.</dd>
<dd><code>supplier</code> - Supplier to store</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="supports-com.djrapitops.plan.delivery.domain.keys.Key-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supports</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>&lt;T&gt;&nbsp;boolean&nbsp;supports(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key)</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Check if a Value with the given Key has been placed into the container.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object returned by the Value if it is present.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key that identifies the data.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if found, false if not.</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="getValue-com.djrapitops.plan.delivery.domain.keys.Key-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>&lt;T&gt;&nbsp;java.util.Optional&lt;T&gt;&nbsp;getValue(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key)</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get an Optional of the Value identified by the Key.
<p>
It is recommended to check if the Optional is present as null values will be empty.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object returned by Value</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key that identifies the Value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional of the object if the key is registered and key matches the type of the object. Otherwise empty.</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="getUnsafe-com.djrapitops.plan.delivery.domain.keys.Key-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnsafe</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>&lt;T&gt;&nbsp;T&nbsp;getUnsafe(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key)</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get data identified by the Key, or throw an exception.
<p>
Updated javadocs
2019-10-05 10:27:37 +02:00
It is recommended to use <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#supports-com.djrapitops.plan.delivery.domain.keys.Key-"><code>supports(Key)</code></a> before using this method.</div>
Updated javadocs
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object returned by Value</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key that identifies the Value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If the key is not supported.</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="getFormatted-com.djrapitops.plan.delivery.domain.keys.Key-com.djrapitops.plan.delivery.formatting.Formatter-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormatted</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>default&nbsp;&lt;T&gt;&nbsp;java.lang.String&nbsp;getFormatted(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
<a href="../../../../../../com/djrapitops/plan/delivery/formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a>&lt;java.util.Optional&lt;T&gt;&gt;&nbsp;formatter)</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get formatted Value identified by the Key.
<p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object returned by Value</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key that identifies the Value</dd>
Updated javadocs
2019-10-05 10:27:37 +02:00
<dd><code>formatter</code> - Formatter for the Optional returned by <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#getValue-com.djrapitops.plan.delivery.domain.keys.Key-"><code>getValue(Key)</code></a></dd>
Updated javadocs
2019-08-05 11:13:19 +02:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional of the object if the key is registered and key matches the type of the object. Otherwise empty.</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="getFormattedUnsafe-com.djrapitops.plan.delivery.domain.keys.Key-com.djrapitops.plan.delivery.formatting.Formatter-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormattedUnsafe</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>default&nbsp;&lt;T&gt;&nbsp;java.lang.String&nbsp;getFormattedUnsafe(<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>&lt;T&gt;&nbsp;key,
<a href="../../../../../../com/djrapitops/plan/delivery/formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a>&lt;T&gt;&nbsp;formatter)</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Get formatted Value identified by the Key, or throw an exception.
<p>
Updated javadocs
2019-10-05 10:27:37 +02:00
It is recommended to use <a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html#supports-com.djrapitops.plan.delivery.domain.keys.Key-"><code>supports(Key)</code></a> before using this method.</div>
Updated javadocs
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object returned by Value</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key that identifies the Value</dd>
<dd><code>formatter</code> - Formatter for the value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If the key is not supported.</dd>
</dl>
</li>
</ul>
Updated javadocs
2019-10-05 10:27:37 +02:00
<a name="putAll-com.djrapitops.plan.delivery.domain.container.DataContainer-">
Updated javadocs
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAll</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>void&nbsp;putAll(<a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a>&nbsp;dataContainer)</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Place all values from given DataContainer into this container.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataContainer</code> - Container with values.</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>void&nbsp;clear()</pre>
<div class="block">Clear the container of all data.</div>
</li>
</ul>
<a name="getMap--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMap</h4>
Updated javadocs
2019-10-05 10:27:37 +02:00
<pre>java.util.Map&lt;<a href="../../../../../../com/djrapitops/plan/delivery/domain/keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>,java.lang.Object&gt;&nbsp;getMap()</pre>
Updated javadocs
2019-08-05 11:13:19 +02:00
<div class="block">Return a Key - Value Map of the data in the container.
<p>
This method may call blocking methods if underlying implementation uses the given Suppliers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map: Key - Object</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">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/CachingSupplier.html" title="class in com.djrapitops.plan.delivery.domain.container"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/djrapitops/plan/delivery/domain/container/DynamicDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
Updated javadocs
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../../index.html?com/djrapitops/plan/delivery/domain/container/DataContainer.html" target="_top">Frames</a></li>
Updated javadocs
2019-08-05 11:13:19 +02:00
<li><a href="DataContainer.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