Deploying to javadoc from @ Relism/Flash5@6314bcff5f 🚀
This commit is contained in:
Relism
@@ -0,0 +1,221 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang>
|
||||
<head>
|
||||
<!-- Generated by javadoc (21) on Mon May 11 14:20:32 UTC 2026 -->
|
||||
<title>FlashExtension (flash-parent 2.1.0-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="dc.created" content="2026-05-11">
|
||||
<meta name="description" content="declaration: package: dev.relism.flash.extension, interface: FlashExtension">
|
||||
<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">
|
||||
<script type="text/javascript" src="../../../../script.js"></script>
|
||||
<script type="text/javascript" src="../../../../script-dir/jquery-3.7.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button>
|
||||
<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="class-use/FlashExtension.html">Use</a></li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../../../../index-all.html">Index</a></li>
|
||||
<li><a href="../../../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list-small">
|
||||
<li>
|
||||
<p>Summary:</p>
|
||||
<ul>
|
||||
<li>Nested</li>
|
||||
<li>Field</li>
|
||||
<li>Constr</li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>Detail:</p>
|
||||
<ul>
|
||||
<li>Field</li>
|
||||
<li>Constr</li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div id="navbar-sub-list">
|
||||
<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"><a href="../../../../search.html">SEARCH</a>
|
||||
<input type="text" id="search-input" disabled placeholder="Search">
|
||||
<input type="reset" id="reset-button" disabled value="reset">
|
||||
</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">dev.relism.flash.extension</a></div>
|
||||
<h1 title="Interface FlashExtension" class="title">Interface FlashExtension</h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">FlashExtension</span></div>
|
||||
<div class="block">Two-phase contract for all Flash extensions.
|
||||
|
||||
<p>Extension lifecycle inside <a href="FlashApp.html#start()"><code>FlashApp.start()</code></a>:
|
||||
<ol>
|
||||
<li>Extensions are sorted by <a href="#priority()"><code>priority()</code></a> — lower value runs first.</li>
|
||||
<li><b>Provide phase</b> — <a href="#provide(dev.relism.flash.extension.FlashContext)"><code>provide(FlashContext)</code></a> is called for <em>all</em>
|
||||
installed extensions. Use this phase to register services, annotation processors,
|
||||
and route listeners. Never call <a href="FlashContext.html#require(java.lang.Class)"><code>FlashContext.require(java.lang.Class<T>)</code></a> here.</li>
|
||||
<li>Context resolution — <code>FlashContext.resolveAll()</code> performs topological
|
||||
resolution of lazy suppliers. Circular or missing dependencies fail here with
|
||||
a clear message before any request is served.</li>
|
||||
<li><b>Routes phase</b> — <a href="#routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)"><code>routes(FlashRegistrar, FlashContext)</code></a> is called for
|
||||
all extensions. All services are resolved; <a href="FlashContext.html#require(java.lang.Class)"><code>FlashContext.require(java.lang.Class<T>)</code></a> is safe.</li>
|
||||
</ol>
|
||||
|
||||
<h3 id="priority-and-middleware-ordering-heading">Priority and middleware ordering</h3>
|
||||
<a href="#priority()"><code>priority()</code></a> controls the order annotation processors are registered, which
|
||||
determines the annotation-layer middleware chain position:
|
||||
<pre>
|
||||
Request ──► EARLY processors' mw ──► DEFAULT processors' mw ──► LATE processors' mw ──► handler
|
||||
</pre>
|
||||
Use <a href="ExtensionPhase.html" title="enum class in dev.relism.flash.extension"><code>ExtensionPhase</code></a> constants for semantic ordering:
|
||||
<pre><code>
|
||||
@Override public int priority() { return ExtensionPhase.EARLY.value; }
|
||||
</code></pre>
|
||||
|
||||
<h3 id="example-heading">Example</h3>
|
||||
<pre><code>
|
||||
public class MetricsExtension implements FlashExtension {
|
||||
|
||||
@Override public int priority() { return ExtensionPhase.LATE.value; }
|
||||
|
||||
@Override
|
||||
public void provide(FlashContext ctx) {
|
||||
ctx.provide(MetricsRegistry.class, new PromMetricsRegistry());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void routes(FlashRegistrar<?> app, FlashContext ctx) {
|
||||
app.get("/metrics", (req, res) -> ctx.require(MetricsRegistry.class).scrape());
|
||||
}
|
||||
}
|
||||
</code></pre></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-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" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="summary-table three-column-summary">
|
||||
<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-tab5"><code>default int</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#priority()" class="member-name-link">priority</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
||||
<div class="block">Execution priority.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#provide(dev.relism.flash.extension.FlashContext)" class="member-name-link">provide</a><wbr>(<a href="FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a> ctx)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
||||
<div class="block">Phase 1 — register services and processors.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)" class="member-name-link">routes</a><wbr>(<a href="FlashRegistrar.html" title="class in dev.relism.flash.extension">FlashRegistrar</a><?> app,
|
||||
<a href="FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a> ctx)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
||||
<div class="block">Phase 2 — register routes.</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="provide(dev.relism.flash.extension.FlashContext)">
|
||||
<h3>provide</h3>
|
||||
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">provide</span><wbr><span class="parameters">(<a href="FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a> ctx)</span></div>
|
||||
<div class="block">Phase 1 — register services and processors.
|
||||
Safe: <a href="FlashContext.html#provide(java.lang.Class,T)"><code>FlashContext.provide(java.lang.Class<T>, T)</code></a>, <a href="FlashContext.html#supply(java.lang.Class,java.util.function.Supplier)"><code>FlashContext.supply(java.lang.Class<T>, java.util.function.Supplier<T>)</code></a>,
|
||||
<a href="FlashContext.html#addAnnotationProcessor(dev.relism.flash.extension.AnnotationProcessor)"><code>FlashContext.addAnnotationProcessor(dev.relism.flash.extension.AnnotationProcessor)</code></a>, <a href="FlashContext.html#addRouteListener(dev.relism.flash.extension.RouteListener)"><code>FlashContext.addRouteListener(dev.relism.flash.extension.RouteListener)</code></a>.
|
||||
Unsafe: <a href="FlashContext.html#require(java.lang.Class)"><code>FlashContext.require(java.lang.Class<T>)</code></a> (services not yet resolved).</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)">
|
||||
<h3>routes</h3>
|
||||
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">routes</span><wbr><span class="parameters">(<a href="FlashRegistrar.html" title="class in dev.relism.flash.extension">FlashRegistrar</a><?> app,
|
||||
<a href="FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a> ctx)</span></div>
|
||||
<div class="block">Phase 2 — register routes. All services are fully resolved.
|
||||
<a href="FlashContext.html#require(java.lang.Class)"><code>FlashContext.require(java.lang.Class<T>)</code></a> is safe here.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="priority()">
|
||||
<h3>priority</h3>
|
||||
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">priority</span>()</div>
|
||||
<div class="block">Execution priority. Lower = earlier in the annotation middleware chain.
|
||||
Tie-breaking: same value → install order (sort is stable).
|
||||
Default: <a href="ExtensionPhase.html#DEFAULT"><code>ExtensionPhase.DEFAULT</code></a> (500).</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
<footer role="contentinfo">
|
||||
<hr>
|
||||
<p class="legal-copy"><small>Copyright © 2026. All rights reserved.</small></p>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user