mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-12-29 04:27:53 +01:00
384 lines
32 KiB
HTML
384 lines
32 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>DataContainer (Plan 5.4-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: com.djrapitops.plan.delivery.domain.container, interface: DataContainer">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.delivery.domain.container</a></div>
|
|
<h1 title="Interface DataContainer" class="title">Interface DataContainer</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</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="DynamicDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">DynamicDataContainer</a></code>, <code><a href="PlayerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">PlayerContainer</a></code>, <code><a href="RawDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">RawDataContainer</a></code>, <code><a href="ServerContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">ServerContainer</a></code>, <code><a href="SupplierDataContainer.html" title="class in com.djrapitops.plan.delivery.domain.container">SupplierDataContainer</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DataContainer</span></div>
|
|
<div class="block">Interface for an object that can store arbitrary data referenced via <a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys"><code>Key</code></a> objects.
|
|
<p>
|
|
Implementations should mainly be concerned on how the data given to it is stored.
|
|
Retrieval has some details that should be followed.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Clear the container of all data.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <T> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getFormatted(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)" class="member-name-link">getFormatted</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="../../formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><T>> formatter)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Get formatted Value identified by the Key.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <T> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getFormattedUnsafe(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)" class="member-name-link">getFormattedUnsafe</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="../../formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a><T> formatter)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Get formatted Value identified by the Key, or throw an exception.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMap()" class="member-name-link">getMap</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Return a Key - Value Map of the data in the container.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUnsafe(com.djrapitops.plan.delivery.domain.keys.Key)" class="member-name-link">getUnsafe</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Get data identified by the Key, or throw an exception.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><T></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValue(com.djrapitops.plan.delivery.domain.keys.Key)" class="member-name-link">getValue</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Get an Optional of the Value identified by the Key.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><?></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#handleList(java.util.List)" class="member-name-link">handleList</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><?> list)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><?,<wbr>?></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#handleMap(java.util.Map)" class="member-name-link">handleMap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><?,<wbr>?> map)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#mapToNormalMap()" class="member-name-link">mapToNormalMap</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putAll(com.djrapitops.plan.delivery.domain.container.DataContainer)" class="member-name-link">putAll</a><wbr>(<a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a> dataContainer)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Place all values from given DataContainer into this container.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putCachingSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)" class="member-name-link">putCachingSupplier</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Place a caching data supplier inside the container.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putRawData(com.djrapitops.plan.delivery.domain.keys.Key,T)" class="member-name-link">putRawData</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
T obj)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Place your data inside the container.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)" class="member-name-link">putSupplier</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Place a data supplier inside the container.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#supports(com.djrapitops.plan.delivery.domain.keys.Key)" class="member-name-link">supports</a><wbr>(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Check if a Value with the given Key has been placed into the container.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="mapToNormalMap()">
|
|
<h3>mapToNormalMap</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">mapToNormalMap</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="handleList(java.util.List)">
|
|
<h3>handleList</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><?></span> <span class="element-name">handleList</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><?> list)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="handleMap(java.util.Map)">
|
|
<h3>handleMap</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><?,<wbr>?></span> <span class="element-name">handleMap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><?,<wbr>?> map)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="putRawData(com.djrapitops.plan.delivery.domain.keys.Key,T)">
|
|
<h3 id="putRawData(com.djrapitops.plan.delivery.domain.keys.Key,java.lang.Object)">putRawData</h3>
|
|
<div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">void</span> <span class="element-name">putRawData</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
T obj)</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 class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object</dd>
|
|
<dt>Parameters:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="putSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">
|
|
<h3>putSupplier</h3>
|
|
<div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">void</span> <span class="element-name">putSupplier</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</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 class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object</dd>
|
|
<dt>Parameters:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="putCachingSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)">
|
|
<h3>putCachingSupplier</h3>
|
|
<div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">void</span> <span class="element-name">putCachingSupplier</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><T> supplier)</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 class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object</dd>
|
|
<dt>Parameters:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="supports(com.djrapitops.plan.delivery.domain.keys.Key)">
|
|
<h3>supports</h3>
|
|
<div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">boolean</span> <span class="element-name">supports</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</span></div>
|
|
<div class="block">Check if a Value with the given Key has been placed into the container.</div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object returned by the Value if it is present.</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - Key that identifies the data.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if found, false if not.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getValue(com.djrapitops.plan.delivery.domain.keys.Key)">
|
|
<h3>getValue</h3>
|
|
<div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><T></span> <span class="element-name">getValue</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</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 class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object returned by Value</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - Key that identifies the Value</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Optional of the object if the key is registered and key matches the type of the object. Otherwise empty.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getUnsafe(com.djrapitops.plan.delivery.domain.keys.Key)">
|
|
<h3>getUnsafe</h3>
|
|
<div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getUnsafe</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key)</span></div>
|
|
<div class="block">Get data identified by the Key, or throw an exception.
|
|
<p>
|
|
It is recommended to use <a href="#supports(com.djrapitops.plan.delivery.domain.keys.Key)"><code>supports(Key)</code></a> before using this method.</div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object returned by Value</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - Key that identifies the Value</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the value</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If the key is not supported.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFormatted(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)">
|
|
<h3>getFormatted</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFormatted</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="../../formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><T>> formatter)</span></div>
|
|
<div class="block">Get formatted Value identified by the Key.
|
|
<p></div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object returned by Value</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - Key that identifies the Value</dd>
|
|
<dd><code>formatter</code> - Formatter for the Optional returned by <a href="#getValue(com.djrapitops.plan.delivery.domain.keys.Key)"><code>getValue(Key)</code></a></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Optional of the object if the key is registered and key matches the type of the object. Otherwise empty.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFormattedUnsafe(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)">
|
|
<h3>getFormattedUnsafe</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFormattedUnsafe</span><wbr><span class="parameters">(<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a><T> key,
|
|
<a href="../../formatting/Formatter.html" title="interface in com.djrapitops.plan.delivery.formatting">Formatter</a><T> formatter)</span></div>
|
|
<div class="block">Get formatted Value identified by the Key, or throw an exception.
|
|
<p>
|
|
It is recommended to use <a href="#supports(com.djrapitops.plan.delivery.domain.keys.Key)"><code>supports(Key)</code></a> before using this method.</div>
|
|
<dl class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object returned by Value</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - Key that identifies the Value</dd>
|
|
<dd><code>formatter</code> - Formatter for the value</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the value</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If the key is not supported.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="putAll(com.djrapitops.plan.delivery.domain.container.DataContainer)">
|
|
<h3>putAll</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">putAll</span><wbr><span class="parameters">(<a href="DataContainer.html" title="interface in com.djrapitops.plan.delivery.domain.container">DataContainer</a> dataContainer)</span></div>
|
|
<div class="block">Place all values from given DataContainer into this container.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>dataContainer</code> - Container with values.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clear()">
|
|
<h3>clear</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">clear</span>()</div>
|
|
<div class="block">Clear the container of all data.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getMap()">
|
|
<h3>getMap</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../keys/Key.html" title="class in com.djrapitops.plan.delivery.domain.keys">Key</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getMap</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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Map: Key - Object</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|