2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2019-08-05 11:13:19 +02:00
< head >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
2021-03-10 09:12:21 +01:00
< title > DataContainer (Plan 5.2-SNAPSHOT API)< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../../stylesheet.css" title = "Style" >
2021-03-10 09:12:21 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../../jquery/jquery-ui.css" title = "Style" >
2019-08-05 11:13:19 +02:00
< script type = "text/javascript" src = "../../../../../../script.js" > < / script >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-03-10 09:12:21 +01:00
parent.document.title="DataContainer (Plan 5.2-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var data = {"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};
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";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');< / script >
2019-08-05 11:13:19 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-03-10 09:12:21 +01:00
< header role = "banner" >
< nav role = "navigation" >
< div class = "fixedNav" >
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.top.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" id = "allclasses_navbar_top" >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2021-03-10 09:12:21 +01:00
< / div >
< div class = "navPadding" > < / div >
< script type = "text/javascript" > < ! - -
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
< / script >
< / nav >
< / header >
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2019-08-05 11:13:19 +02:00
< div class = "header" >
2021-03-10 09:12:21 +01:00
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.delivery.domain.container< / a > < / div >
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 >
2021-03-13 07:16:50 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
< pre > public interface < span class = "typeNameLabel" > DataContainer< / span > < / pre >
2021-03-10 09:12:21 +01:00
< 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.
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 =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.summary" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2019-08-05 11:13:19 +02:00
< 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 = "t3" class = "tableTab" > < span > < a href = "javascript:show(4);" > Abstract Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t5" class = "tableTab" > < span > < a href = "javascript:show(16);" > Default Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Method< / th >
< th class = "colLast" scope = "col" > Description< / th >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i0" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#clear()" > clear< / a > < / span > ()< / code > < / th >
< td class = "colLast" >
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 < T> java.lang.String< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getFormatted(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)" > getFormatted< / a > < / span > ​ (< 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 > < java.util.Optional< T> > formatter)< / code > < / th >
< td class = "colLast" >
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 < T> java.lang.String< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getFormattedUnsafe(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)" > getFormattedUnsafe< / a > < / span > ​ (< 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 > < / th >
< td class = "colLast" >
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" >
2021-03-10 09:12:21 +01:00
< 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" >
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 > < T> T< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
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 > < T> java.util.Optional< T> < / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
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" >
2020-03-21 15:43:05 +01:00
< td class = "colFirst" > < code > default java.util.List< ?> < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#handleList(java.util.List)" > handleList< / a > < / span > ​ (java.util.List< ?> list)< / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< tr id = "i7" class = "rowColor" >
2021-03-10 09:12:21 +01:00
< td class = "colFirst" > < code > default java.util.Map< ?,​ ?> < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#handleMap(java.util.Map)" > handleMap< / a > < / span > ​ (java.util.Map< ?,​ ?> map)< / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< tr id = "i8" class = "altColor" >
2021-03-10 09:12:21 +01:00
< td class = "colFirst" > < code > default java.util.Map< java.lang.String,​ java.lang.Object> < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#mapToNormalMap()" > mapToNormalMap< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< tr id = "i9" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > void< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Place all values from given DataContainer into this container.< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i10" class = "altColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > < T> void< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Place a caching data supplier inside the container.< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i11" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > < T> void< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Place your data inside the container.< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i12" class = "altColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > < T> void< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Place a data supplier inside the container.< / div >
< / td >
< / tr >
2020-03-21 15:43:05 +01:00
< tr id = "i13" class = "rowColor" >
2019-08-05 11:13:19 +02:00
< td class = "colFirst" > < code > < T> boolean< / code > < / td >
2021-03-10 09:12:21 +01:00
< 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" >
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 >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ METHOD DETAIL ========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.detail" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "mapToNormalMap()" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > mapToNormalMap< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > default java.util.Map< java.lang.String,​ java.lang.Object> mapToNormalMap()< / pre >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "handleList(java.util.List)" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > handleList< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > default java.util.List< ?> handleList​ (java.util.List< ?> list)< / pre >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "handleMap(java.util.Map)" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > handleMap< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > default java.util.Map< ?,​ ?> handleMap​ (java.util.Map< ?,​ ?> map)< / pre >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "putRawData(com.djrapitops.plan.delivery.domain.keys.Key,java.lang.Object)" >
2019-08-05 11:13:19 +02:00
<!-- -->
2021-03-10 09:12:21 +01:00
< / a > < a id = "putRawData(com.djrapitops.plan.delivery.domain.keys.Key,T)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > putRawData< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < T> void putRawData​ (< a href = "../keys/Key.html" title = "class in com.djrapitops.plan.delivery.domain.keys" > Key< / a > < T> key,
2019-08-05 11:13:19 +02:00
T 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 >
2021-03-10 09:12:21 +01:00
< a id = "putSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > putSupplier< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < T> void putSupplier​ (< a href = "../keys/Key.html" title = "class in com.djrapitops.plan.delivery.domain.keys" > Key< / a > < T> key,
2019-08-05 11:13:19 +02:00
java.util.function.Supplier< T> 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 >
2021-03-10 09:12:21 +01:00
< a id = "putCachingSupplier(com.djrapitops.plan.delivery.domain.keys.Key,java.util.function.Supplier)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > putCachingSupplier< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < T> void putCachingSupplier​ (< a href = "../keys/Key.html" title = "class in com.djrapitops.plan.delivery.domain.keys" > Key< / a > < T> key,
2019-08-05 11:13:19 +02:00
java.util.function.Supplier< T> 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 >
2021-03-10 09:12:21 +01:00
< a id = "supports(com.djrapitops.plan.delivery.domain.keys.Key)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > supports< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < T> boolean supports​ (< a href = "../keys/Key.html" title = "class in com.djrapitops.plan.delivery.domain.keys" > Key< / a > < T> key)< / pre >
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 >
2021-03-10 09:12:21 +01:00
< a id = "getValue(com.djrapitops.plan.delivery.domain.keys.Key)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getValue< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < 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 >
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 >
2021-03-10 09:12:21 +01:00
< a id = "getUnsafe(com.djrapitops.plan.delivery.domain.keys.Key)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getUnsafe< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < T> T getUnsafe​ (< a href = "../keys/Key.html" title = "class in com.djrapitops.plan.delivery.domain.keys" > Key< / a > < T> key)< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get data identified by the Key, or throw an exception.
< p >
2021-03-10 09:12:21 +01:00
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 >
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 >
2021-03-10 09:12:21 +01:00
< a id = "getFormatted(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getFormatted< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > default < T> java.lang.String getFormatted​ (< 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 > < java.util.Optional< T> > formatter)< / pre >
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 >
2021-03-10 09:12:21 +01:00
< 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 >
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 >
2021-03-10 09:12:21 +01:00
< a id = "getFormattedUnsafe(com.djrapitops.plan.delivery.domain.keys.Key,com.djrapitops.plan.delivery.formatting.Formatter)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getFormattedUnsafe< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > default < T> java.lang.String getFormattedUnsafe​ (< 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)< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Get formatted Value identified by the Key, or throw an exception.
< p >
2021-03-10 09:12:21 +01:00
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 >
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 >
2021-03-10 09:12:21 +01:00
< a id = "putAll(com.djrapitops.plan.delivery.domain.container.DataContainer)" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > putAll< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > void putAll​ (< a href = "DataContainer.html" title = "interface in com.djrapitops.plan.delivery.domain.container" > DataContainer< / a > dataContainer)< / pre >
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 >
2021-03-10 09:12:21 +01:00
< a id = "clear()" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > clear< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > void clear()< / pre >
2019-08-05 11:13:19 +02:00
< div class = "block" > Clear the container of all data.< / div >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getMap()" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getMap< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > java.util.Map< < a href = "../keys/Key.html" title = "class in com.djrapitops.plan.delivery.domain.keys" > Key< / a > ,​ java.lang.Object> getMap()< / pre >
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 >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.bottom.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" id = "allclasses_navbar_bottom" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../../allclasses.html" > All Classes< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2019-08-05 11:13:19 +02:00
< / body >
< / html >
