Content of file MetadataSupport.html
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Mon Apr 24 04:48:49 UTC 2023 -->
<title>MetadataSupport (blueMarine II :: Model 1.1-ALPHA-2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-04-24">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/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="../../../../../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.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MetadataSupport (blueMarine II :: Model 1.1-ALPHA-2-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="class-use/MetadataSupport.html">Use</a></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><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">it.tidalwave.bluemarine2.model.spi</a></div>
<h2 title="Class MetadataSupport" class="title">Class MetadataSupport</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>it.tidalwave.bluemarine2.model.spi.MetadataSupport</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
</dl>
<hr>
<object type="image/svg+xml" data="MetadataSupport.svg" style="max-width:60%;float:right;"></object>
<pre style="white-space:pre-wrap;">public class <span class="typeNameLabel">MetadataSupport</span>
extends java.lang.Object
implements <a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></pre>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Fabrizio Giudici</dd>
</dl>
</li>
</ul>
</div>
<div class="summary" style="clear:right;">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.it.tidalwave.bluemarine2.model.MediaItem.Metadata">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface it.tidalwave.bluemarine2.model.<a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></h3>
<code><a href="../MediaItem.Metadata.Cddb.html" title="class in it.tidalwave.bluemarine2.model">MediaItem.Metadata.Cddb</a>, <a href="../MediaItem.Metadata.ITunesComment.html" title="class in it.tidalwave.bluemarine2.model">MediaItem.Metadata.ITunesComment</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Optional<java.util.function.Function<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​<a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a>>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fallback">fallback</a></span></code></th>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.nio.file.Path</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#path">path</a></span></code></th>
<td class="colLast"> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​java.lang.Object></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties">properties</a></span></code></th>
<td class="colLast"> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.it.tidalwave.bluemarine2.model.MediaItem.Metadata">
<!-- -->
</a>
<h3>Fields inherited from interface it.tidalwave.bluemarine2.model.<a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></h3>
<code><a href="../MediaItem.Metadata.html#ALBUM">ALBUM</a>, <a href="../MediaItem.Metadata.html#ARTIST">ARTIST</a>, <a href="../MediaItem.Metadata.html#ARTWORK">ARTWORK</a>, <a href="../MediaItem.Metadata.html#BIT_RATE">BIT_RATE</a>, <a href="../MediaItem.Metadata.html#BITS_PER_SAMPLE">BITS_PER_SAMPLE</a>, <a href="../MediaItem.Metadata.html#CDDB">CDDB</a>, <a href="../MediaItem.Metadata.html#CHANNELS">CHANNELS</a>, <a href="../MediaItem.Metadata.html#COMMENT">COMMENT</a>, <a href="../MediaItem.Metadata.html#COMPOSER">COMPOSER</a>, <a href="../MediaItem.Metadata.html#DISK_COUNT">DISK_COUNT</a>, <a href="../MediaItem.Metadata.html#DISK_NUMBER">DISK_NUMBER</a>, <a href="../MediaItem.Metadata.html#DURATION">DURATION</a>, <a href="../MediaItem.Metadata.html#ENCODER">ENCODER</a>, <a href="../MediaItem.Metadata.html#ENCODING_TYPE">ENCODING_TYPE</a>, <a href="../MediaItem.Metadata.html#FILE_SIZE">FILE_SIZE</a>, <a href="../MediaItem.Metadata.html#FORMAT">FORMAT</a>, <a href="../MediaItem.Metadata.html#ITUNES_COMMENT">ITUNES_COMMENT</a>, <a href="../MediaItem.Metadata.html#MBZ_ARTIST_ID">MBZ_ARTIST_ID</a>, <a href="../MediaItem.Metadata.html#MBZ_DISC_ID">MBZ_DISC_ID</a>, <a href="../MediaItem.Metadata.html#MBZ_TRACK_ID">MBZ_TRACK_ID</a>, <a href="../MediaItem.Metadata.html#MBZ_WORK_ID">MBZ_WORK_ID</a>, <a href="../MediaItem.Metadata.html#PUBLISHER">PUBLISHER</a>, <a href="../MediaItem.Metadata.html#SAMPLE_RATE">SAMPLE_RATE</a>, <a href="../MediaItem.Metadata.html#TITLE">TITLE</a>, <a href="../MediaItem.Metadata.html#TRACK_NUMBER">TRACK_NUMBER</a>, <a href="../MediaItem.Metadata.html#YEAR">YEAR</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<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(java.nio.file.Path)">MetadataSupport</a></span>​(java.nio.file.Path path)</code></th>
<td class="colLast"> </td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsKey(it.tidalwave.util.Key)">containsKey</a></span>​(<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?> key)</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if an item with the given key is present.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><T> java.util.Optional<T></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(it.tidalwave.util.Key)">get</a></span>​(<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key)</code></th>
<td class="colLast">
<div class="block">Extracts a single metadata item associated to the given key.</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="#getAll(it.tidalwave.util.Key)">getAll</a></span>​(<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key)</code></th>
<td class="colLast">
<div class="block">Extracts a metadata item (typically a collection) associated to the given key.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Set<java.util.Map.Entry<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​?>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntries()">getEntries</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all the entries (key -> value) contained in this instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeys()">getKeys</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all the keys contained in this instance.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <V> void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#put(it.tidalwave.util.Key,V)">put</a></span>​(<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><V> key,
V value)</code></th>
<td class="colLast">
<div class="block">FIXME: remove this, make it truly immutable.</div>
| remove this, make it truly immutable. | |
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><T> <a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#with(it.tidalwave.util.Key,java.util.Optional)">with</a></span>​(<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key,
java.util.Optional<T> value)</code></th>
<td class="colLast">
<div class="block">Returns a clone of this object with an additional optional value.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><T> <a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#with(it.tidalwave.util.Key,T)">with</a></span>​(<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key,
T value)</code></th>
<td class="colLast">
<div class="block">Returns a clone of this object with an additional item.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withFallback(java.util.function.Function)">withFallback</a></span>​(java.util.function.Function<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​<a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a>> fallback)</code></th>
<td class="colLast">
<div class="block">Returns a clone of this object with a fallback data source; when an item is searched and not found, before
giving up it will be searched in the given fallback.</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>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="path">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>path</h4>
<pre>@Nonnull
protected final java.nio.file.Path path</pre>
</li>
</ul>
<a id="fallback">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fallback</h4>
<pre>@Nonnull
protected java.util.Optional<java.util.function.Function<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​<a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a>>> fallback</pre>
</li>
</ul>
<a id="properties">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>properties</h4>
<pre>protected final java.util.Map<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​java.lang.Object> properties</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="<init>(java.nio.file.Path)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MetadataSupport</h4>
<pre>public MetadataSupport​(@Nonnull
java.nio.file.Path path)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="get(it.tidalwave.util.Key)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">@Nonnull
public <T> java.util.Optional<T> get​(@Nonnull
<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key)</pre>
<div class="block">Extracts a single metadata item associated to the given key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#get(it.tidalwave.util.Key)">get</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of the item</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the item</dd>
</dl>
</li>
</ul>
<a id="getAll(it.tidalwave.util.Key)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAll</h4>
<pre class="methodSignature">@Nonnull
public <T> T getAll​(@Nonnull
<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key)</pre>
<div class="block">Extracts a metadata item (typically a collection) associated to the given key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#getAll(it.tidalwave.util.Key)">getAll</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of the item</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the item</dd>
</dl>
</li>
</ul>
<a id="containsKey(it.tidalwave.util.Key)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre class="methodSignature">public boolean containsKey​(@Nonnull
<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?> key)</pre>
<div class="block">Returns <code>true</code> if an item with the given key is present.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#containsKey(it.tidalwave.util.Key)">containsKey</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if found</dd>
</dl>
</li>
</ul>
<a id="getKeys()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeys</h4>
<pre class="methodSignature">@Nonnull
public java.util.Set<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>> getKeys()</pre>
<div class="block">Returns all the keys contained in this instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#getKeys()">getKeys</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the keys</dd>
</dl>
</li>
</ul>
<a id="getEntries()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntries</h4>
<pre class="methodSignature">@Nonnull
public java.util.Set<java.util.Map.Entry<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​?>> getEntries()</pre>
<div class="block">Returns all the entries (key -> value) contained in this instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#getEntries()">getEntries</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the entries</dd>
</dl>
</li>
</ul>
<a id="with(it.tidalwave.util.Key,java.lang.Object)">
<!-- -->
</a><a id="with(it.tidalwave.util.Key,T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre class="methodSignature">@Nonnull
public <T> <a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a> with​(@Nonnull
<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key,
@Nonnull
T value)</pre>
<div class="block">Returns a clone of this object with an additional item.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#with(it.tidalwave.util.Key,T)">with</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of the item</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key</dd>
<dd><code>value</code> - the value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the clone</dd>
</dl>
</li>
</ul>
<a id="withFallback(java.util.function.Function)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withFallback</h4>
<pre class="methodSignature">@Nonnull
public <a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a> withFallback​(@Nonnull
java.util.function.Function<<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><?>,​<a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a>> fallback)</pre>
<div class="block">Returns a clone of this object with a fallback data source; when an item is searched and not found, before
giving up it will be searched in the given fallback.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#withFallback(java.util.function.Function)">withFallback</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fallback</code> - the fallback</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the clone</dd>
</dl>
</li>
</ul>
<a id="with(it.tidalwave.util.Key,java.util.Optional)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre class="methodSignature">@Nonnull
public <T> <a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a> with​(@Nonnull
<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><T> key,
@Nonnull
java.util.Optional<T> value)</pre>
<div class="block">Returns a clone of this object with an additional optional value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MediaItem.Metadata.html#with(it.tidalwave.util.Key,java.util.Optional)">with</a></code> in interface <code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of the item</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key</dd>
<dd><code>value</code> - the value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the clone</dd>
</dl>
</li>
</ul>
<a id="put(it.tidalwave.util.Key,java.lang.Object)">
<!-- -->
</a><a id="put(it.tidalwave.util.Key,V)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>put</h4>
<pre class="methodSignature">protected <V> void put​(@Nonnull
<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/Key.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">Key</a><V> key,
@Nullable
V value)</pre>
<div class="block">FIXME: remove this, make it truly immutable.</div>
</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="class-use/MetadataSupport.html">Use</a></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><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>
<p class="legalCopy"><small>Copyright © 2015–2023 <a href="http://tidalwave.it">Tidalwave s.a.s.</a>. All rights reserved.</small></p>
</footer>
</body>
</html>
![[Jenkins]](/ci/static/0840cea4/images/svgs/logo.svg){kind=logo}
