mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
563 lines
27 KiB
HTML
563 lines
27 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>DynamicDataContainer (Plan 5.3-SNAPSHOT API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
|
|
<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>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="DynamicDataContainer (Plan 5.3-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
|
|
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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../index.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" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../../allclasses.html">All 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>
|
|
</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>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.delivery.domain.container</a></div>
|
|
<h2 title="Class DynamicDataContainer" class="title">Class DynamicDataContainer</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.djrapitops.plan.delivery.domain.container.DynamicDataContainer</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="../../../data/store/containers/AnalysisContainer.html" title="class in com.djrapitops.plan.data.store.containers">AnalysisContainer</a></code>, <code><a href="PlayerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">PlayerContainer</a></code>, <code><a href="ServerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">ServerContainer</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">DynamicDataContainer</span>
|
|
extends java.lang.Object
|
|
implements <a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></pre>
|
|
<div class="block">DataContainer implementation that delegates the method calls to other DataContainer implementations.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DynamicDataContainer</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Clear the container of all data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>java.util.Map<<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>,​java.lang.Object></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMap()">getMap</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a Key - Value Map of the data in the container.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><T> T</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnsafe(com.djrapitops.plan.delivery.domain.keys.Key)">getUnsafe</a></span>​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get data identified by the Key, or throw an exception.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><T> java.util.Optional<T></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue(com.djrapitops.plan.delivery.domain.keys.Key)">getValue</a></span>​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get an Optional of the Value identified by the Key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putAll(com.djrapitops.plan.delivery.domain.container.DataContainer)">putAll</a></span>​(<a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a> dataContainer)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Place all values from given DataContainer into this container.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><T> void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putCachingSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">putCachingSupplier</a></span>​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
java.util.function.Supplier<T> supplier)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Place a caching data supplier inside the container.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><T> void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putRawData(com.djrapitops.plan.delivery.domain.keys.Key,T)">putRawData</a></span>​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
T obj)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Place your data inside the container.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><T> void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">putSupplier</a></span>​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
java.util.function.Supplier<T> supplier)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Place a data supplier inside the container.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><T> boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supports(com.djrapitops.plan.delivery.domain.keys.Key)">supports</a></span>​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Check if a Value with the given Key has been placed into the container.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.delivery.domain.container.DataContainer">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from interface com.djrapitops.plan.delivery.domain.container.<a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></h3>
|
|
<code><a href="DataContainer.html#getFormatted(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)">getFormatted</a>, <a href="DataContainer.html#getFormattedUnsafe(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)">getFormattedUnsafe</a>, <a href="DataContainer.html#handleList(java.util.List)">handleList</a>, <a href="DataContainer.html#handleMap(java.util.Map)">handleMap</a>, <a href="DataContainer.html#mapToNormalMap()">mapToNormalMap</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a id="<init>()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>DynamicDataContainer</h4>
|
|
<pre>public DynamicDataContainer()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="putRawData(com.djrapitops.plan.delivery.domain.keys.Key,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a id="putRawData(com.djrapitops.plan.delivery.domain.keys.Key,T)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putRawData</h4>
|
|
<pre class="methodSignature">public <T> void putRawData​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
T obj)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#putRawData(com.djrapitops.plan.delivery.domain.keys.Key,T)">DataContainer</a></code></span></div>
|
|
<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="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#putRawData(com.djrapitops.plan.delivery.domain.keys.Key,T)">putRawData</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<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>
|
|
<a id="putSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putSupplier</h4>
|
|
<pre class="methodSignature">public <T> void putSupplier​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
java.util.function.Supplier<T> supplier)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#putSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">DataContainer</a></code></span></div>
|
|
<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="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#putSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">putSupplier</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<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>
|
|
<a id="putCachingSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putCachingSupplier</h4>
|
|
<pre class="methodSignature">public <T> void putCachingSupplier​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
java.util.function.Supplier<T> supplier)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#putCachingSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">DataContainer</a></code></span></div>
|
|
<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="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#putCachingSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">putCachingSupplier</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<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>
|
|
<a id="supports(com.djrapitops.plan.delivery.domain.keys.Key)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>supports</h4>
|
|
<pre class="methodSignature">public <T> boolean supports​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#supports(com.djrapitops.plan.delivery.domain.keys.Key)">DataContainer</a></code></span></div>
|
|
<div class="block">Check if a Value with the given Key has been placed into the container.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#supports(com.djrapitops.plan.delivery.domain.keys.Key)">supports</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<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>
|
|
<a id="getValue(com.djrapitops.plan.delivery.domain.keys.Key)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getValue</h4>
|
|
<pre class="methodSignature">public <T> java.util.Optional<T> getValue​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#getValue(com.djrapitops.plan.delivery.domain.keys.Key)">DataContainer</a></code></span></div>
|
|
<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="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#getValue(com.djrapitops.plan.delivery.domain.keys.Key)">getValue</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<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>
|
|
<a id="getUnsafe(com.djrapitops.plan.delivery.domain.keys.Key)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getUnsafe</h4>
|
|
<pre class="methodSignature">public <T> T getUnsafe​(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#getUnsafe(com.djrapitops.plan.delivery.domain.keys.Key)">DataContainer</a></code></span></div>
|
|
<div class="block">Get data identified by the Key, or throw an exception.
|
|
<p>
|
|
It is recommended to use <a href="DataContainer.html#supports(com.djrapitops.plan.delivery.domain.keys.Key)"><code>DataContainer.supports(Key)</code></a> before using this method.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#getUnsafe(com.djrapitops.plan.delivery.domain.keys.Key)">getUnsafe</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<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>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="putAll(com.djrapitops.plan.delivery.domain.container.DataContainer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putAll</h4>
|
|
<pre class="methodSignature">public void putAll​(<a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a> dataContainer)</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#putAll(com.djrapitops.plan.delivery.domain.container.DataContainer)">DataContainer</a></code></span></div>
|
|
<div class="block">Place all values from given DataContainer into this container.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#putAll(com.djrapitops.plan.delivery.domain.container.DataContainer)">putAll</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dataContainer</code> - Container with values.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="clear()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>clear</h4>
|
|
<pre class="methodSignature">public void clear()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#clear()">DataContainer</a></code></span></div>
|
|
<div class="block">Clear the container of all data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#clear()">clear</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMap()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getMap</h4>
|
|
<pre class="methodSignature">public java.util.Map<<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>,​java.lang.Object> getMap()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataContainer.html#getMap()">DataContainer</a></code></span></div>
|
|
<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="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="DataContainer.html#getMap()">getMap</a></code> in interface <code><a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Map: Key - Object</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../index.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" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|