Content of file PriorityAsSupport.html
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Mon Apr 24 04:47:01 UTC 2023 -->
<title>PriorityAsSupport (blueMarine II :: Commons 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="PriorityAsSupport (blueMarine II :: Commons 1.1-ALPHA-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":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/PriorityAsSupport.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>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">it.tidalwave.util.spi</a></div>
<h2 title="Class PriorityAsSupport" class="title">Class PriorityAsSupport</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>it.tidalwave.util.spi.AsSupport</li>
<li>
<ul class="inheritance">
<li>it.tidalwave.util.spi.PriorityAsSupport</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>it.tidalwave.util.As</code></dd>
</dl>
<hr>
<object type="image/svg+xml" data="PriorityAsSupport.svg" style="max-width:60%;float:right;"></object>
<pre style="white-space:pre-wrap;">public class <span class="typeNameLabel">PriorityAsSupport</span>
extends it.tidalwave.util.spi.AsSupport
implements it.tidalwave.util.As</pre>
<div class="block">A specialisation of <code>AsSupport</code> that deals with multiple roles of the same type by prioritising them; they
are ordered from most relevant to least relevant (where relevance is associated to specialisation, that is most
specialised roles, or roles associated via <code>@DciRole</code> to most specialised datum classes, are most relevant).
FIXME: could be seen as a replacement to <code>AsSupport</code>?</div>
| could be seen as a replacement to AsSupport ? | |
<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>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface </code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PriorityAsSupport.RoleProvider.html" title="interface in it.tidalwave.util.spi">PriorityAsSupport.RoleProvider</a></span></code></th>
<td class="colLast"> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.it.tidalwave.util.As">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface it.tidalwave.util.As</h3>
<code>it.tidalwave.util.As.Defaults, it.tidalwave.util.As.NotFoundBehaviour<T extends java.lang.Object></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.lang.Object)">PriorityAsSupport</a></span>​(java.lang.Object owner)</code></th>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Object,it.tidalwave.util.spi.PriorityAsSupport.RoleProvider,java.util.Collection)">PriorityAsSupport</a></span>​(java.lang.Object owner,
<a href="PriorityAsSupport.RoleProvider.html" title="interface in it.tidalwave.util.spi">PriorityAsSupport.RoleProvider</a> additionalRoleProvider,
java.util.Collection<java.lang.Object> rolesOrFactories)</code></th>
<td class="colLast"> </td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Object,java.util.Collection)">PriorityAsSupport</a></span>​(java.lang.Object owner,
java.util.Collection<java.lang.Object> rolesOrFactories)</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><T> T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#as(java.lang.Class)">as</a></span>​(java.lang.Class<T> type)</code></th>
<td class="colLast">
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><T> T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#as(java.lang.Class,it.tidalwave.util.As.NotFoundBehaviour)">as</a></span>​(java.lang.Class<T> type,
it.tidalwave.util.As.NotFoundBehaviour<T> notFoundBehaviour)</code></th>
<td class="colLast">
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><T> java.util.Collection<T></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asMany(java.lang.Class)">asMany</a></span>​(java.lang.Class<T> type)</code></th>
<td class="colLast">
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><T> java.util.Optional<T></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maybeAs(java.lang.Class)">maybeAs</a></span>​(java.lang.Class<T> type)</code></th>
<td class="colLast">
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.tidalwave.util.As">
<!-- -->
</a>
<h3>Methods inherited from interface it.tidalwave.util.As</h3>
<code>asOptional</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="<init>(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PriorityAsSupport</h4>
<pre>public PriorityAsSupport​(java.lang.Object owner)</pre>
</li>
</ul>
<a id="<init>(java.lang.Object,java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PriorityAsSupport</h4>
<pre>public PriorityAsSupport​(@Nonnull
java.lang.Object owner,
@Nonnull
java.util.Collection<java.lang.Object> rolesOrFactories)</pre>
</li>
</ul>
<a id="<init>(java.lang.Object,it.tidalwave.util.spi.PriorityAsSupport.RoleProvider,java.util.Collection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PriorityAsSupport</h4>
<pre>public PriorityAsSupport​(@Nonnull
java.lang.Object owner,
@Nonnull
<a href="PriorityAsSupport.RoleProvider.html" title="interface in it.tidalwave.util.spi">PriorityAsSupport.RoleProvider</a> additionalRoleProvider,
@Nonnull
java.util.Collection<java.lang.Object> rolesOrFactories)</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="as(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>as</h4>
<pre class="methodSignature">@Nonnull
public <T> T as​(@Nonnull
java.lang.Class<T> type)</pre>
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned. See <a href="#asMany(java.lang.Class)"><code>asMany(java.lang.Class)</code></a> for further details.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>as</code> in interface <code>it.tidalwave.util.As</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>as</code> in class <code>it.tidalwave.util.spi.AsSupport</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#asMany(java.lang.Class)"><code>asMany(java.lang.Class)</code></a></dd>
</dl>
</li>
</ul>
<a id="as(java.lang.Class,it.tidalwave.util.As.NotFoundBehaviour)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>as</h4>
<pre class="methodSignature">@Nonnull
public <T> T as​(@Nonnull
java.lang.Class<T> type,
@Nonnull
it.tidalwave.util.As.NotFoundBehaviour<T> notFoundBehaviour)</pre>
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned. See <a href="#asMany(java.lang.Class)"><code>asMany(java.lang.Class)</code></a> for further details.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>as</code> in interface <code>it.tidalwave.util.As</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>as</code> in class <code>it.tidalwave.util.spi.AsSupport</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#asMany(java.lang.Class)"><code>asMany(java.lang.Class)</code></a></dd>
</dl>
</li>
</ul>
<a id="maybeAs(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maybeAs</h4>
<pre class="methodSignature">@Nonnull
public <T> java.util.Optional<T> maybeAs​(@Nonnull
java.lang.Class<T> type)</pre>
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned. See <a href="#asMany(java.lang.Class)"><code>asMany(java.lang.Class)</code></a> for further details.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>maybeAs</code> in interface <code>it.tidalwave.util.As</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#asMany(java.lang.Class)"><code>asMany(java.lang.Class)</code></a></dd>
</dl>
</li>
</ul>
<a id="asMany(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asMany</h4>
<pre class="methodSignature">@Nonnull
public <T> java.util.Collection<T> asMany​(@Nonnull
java.lang.Class<T> type)</pre>
<div class="block">
Returned roles can be associated both to this type and to the delegate; the one with the higher priority is
returned. The ones associated to this type come with higher priority (this makes sense, being this class a
decorator, specific roles could be associated to it). But given that the default implementation of asMany()
doesn't guarantee ant order (see TFT-192) there's something to take care of. Currently this method contains
some hardwired priority logics.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>asMany</code> in interface <code>it.tidalwave.util.As</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>asMany</code> in class <code>it.tidalwave.util.spi.AsSupport</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PriorityAsSupport.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>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<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>