docs(javadoc): release 2.0.0
This commit is contained in:
@@ -0,0 +1,407 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang>
|
||||
<head>
|
||||
<!-- Generated by javadoc (21) on Tue May 12 13:57:37 UTC 2026 -->
|
||||
<title>FlashRegistrar (flash-parent 2.0.0 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-12">
|
||||
<meta name="description" content="declaration: package: dev.relism.flash.extension, class: FlashRegistrar">
|
||||
<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/FlashRegistrar.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><a href="#constructor-summary">Constr</a></li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>Detail:</p>
|
||||
<ul>
|
||||
<li>Field</li>
|
||||
<li><a href="#constructor-detail">Constr</a></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><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </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="Class FlashRegistrar" class="title">Class FlashRegistrar<SELF extends FlashRegistrar<SELF>></h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">dev.relism.flash.extension.FlashRegistrar<SELF></div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>SELF</code> - concrete registrar type — enables fluent chaining without casting</dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><code><a href="FlashApp.html" title="class in dev.relism.flash.extension">FlashApp</a></code>, <code><a href="FlashScope.html" title="class in dev.relism.flash.extension">FlashScope</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">FlashRegistrar<SELF extends FlashRegistrar<SELF>></span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">Common route-registration surface shared by <a href="FlashApp.html" title="class in dev.relism.flash.extension"><code>FlashApp</code></a> and <a href="FlashScope.html" title="class in dev.relism.flash.extension"><code>FlashScope</code></a>.
|
||||
|
||||
<p>All route methods register <em>immediately</em> — no deferred <code>.with()</code> call.
|
||||
Middleware is passed as a varargs third argument:
|
||||
|
||||
<pre><code>
|
||||
app.get("/ping", (req, res) -> "pong")
|
||||
app.get("/secured", (req, res) -> user(), oidc.protect())
|
||||
app.get("/admin", handler, oidc.requireRole("admin"), rateLimiter)
|
||||
</code></pre>
|
||||
|
||||
<p><a href="FlashExtension.html#routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)"><code>FlashExtension.routes(dev.relism.flash.extension.FlashRegistrar<?>, dev.relism.flash.extension.FlashContext)</code></a> receives a <code>FlashRegistrar<?></code> for route
|
||||
registration. Extension installation (<code>install()</code>) is only available on
|
||||
<a href="FlashApp.html" title="class in dev.relism.flash.extension"><code>FlashApp</code></a> — scoped install is intentionally unsupported.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FlashRegistrar</a>()</code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab3"><code>protected abstract void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addMiddleware(dev.relism.flash.routing.Middleware)" class="member-name-link">addMiddleware</a><wbr>(<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a> mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Registers a middleware in this registrar's own scope (global or scope-level).</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addRoute(dev.relism.flash.http.HttpMethod,java.lang.String,dev.relism.flash.models.RequestHandler,java.util.List)" class="member-name-link">addRoute</a><wbr>(<a href="../http/HttpMethod.html" title="enum class in dev.relism.flash.http">HttpMethod</a> method,
|
||||
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/RequestHandler.html" title="class in dev.relism.flash.models">RequestHandler</a> handler,
|
||||
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>> mw)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Adds a route immediately to this registrar's deferred compilation list.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#connect(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#ctx()" class="member-name-link">ctx</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Returns the <a href="FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a> for this registrar.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#delete(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">delete</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#head(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">head</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <a href="../models/RequestHandler.html" title="class in dev.relism.flash.models">RequestHandler</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#instantiate(java.lang.Class)" class="member-name-link">instantiate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> cls)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#options(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">options</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#patch(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">patch</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#post(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">post</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#purge(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">purge</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#put(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">put</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#scan(java.lang.String)" class="member-name-link">scan</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> packageName)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Scans <code>packageName</code> for <a href="../models/RequestHandler.html" title="class in dev.relism.flash.models"><code>RequestHandler</code></a> subclasses with a routing
|
||||
annotation (<a href="../routing/Route.html" title="annotation interface in dev.relism.flash.routing"><code>@Route</code></a> or <code>@GET</code>, <code>@POST</code>, …).</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trace(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)" class="member-name-link">trace</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#use(dev.relism.flash.routing.Middleware...)" class="member-name-link">use</a><wbr>(<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... middlewares)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Adds middlewares to this registrar's own scope.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>FlashRegistrar</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FlashRegistrar</span>()</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="get(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>get</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="post(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>post</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">post</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="put(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>put</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">put</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="delete(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>delete</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">delete</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="patch(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>patch</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">patch</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="options(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>options</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">options</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="head(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>head</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">head</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="trace(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>trace</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">trace</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="connect(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>connect</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="purge(java.lang.String,dev.relism.flash.models.SimpleHandler.FunctionalHandler,dev.relism.flash.routing.Middleware...)">
|
||||
<h3>purge</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">purge</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/SimpleHandler.FunctionalHandler.html" title="interface in dev.relism.flash.models">SimpleHandler.FunctionalHandler</a> h,
|
||||
<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... mw)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="use(dev.relism.flash.routing.Middleware...)">
|
||||
<h3>use</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">use</span><wbr><span class="parameters">(<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>... middlewares)</span></div>
|
||||
<div class="block">Adds middlewares to this registrar's own scope.
|
||||
On <a href="FlashApp.html" title="class in dev.relism.flash.extension"><code>FlashApp</code></a>: applied to every route on the app.
|
||||
On <a href="FlashScope.html" title="class in dev.relism.flash.extension"><code>FlashScope</code></a>: applied to every route in this scope only.
|
||||
Order-independent: middleware is resolved at <a href="FlashApp.html#start()"><code>FlashApp.start()</code></a>.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="scan(java.lang.String)">
|
||||
<h3>scan</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="FlashRegistrar.html" title="type parameter in FlashRegistrar">SELF</a></span> <span class="element-name">scan</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> packageName)</span></div>
|
||||
<div class="block">Scans <code>packageName</code> for <a href="../models/RequestHandler.html" title="class in dev.relism.flash.models"><code>RequestHandler</code></a> subclasses with a routing
|
||||
annotation (<a href="../routing/Route.html" title="annotation interface in dev.relism.flash.routing"><code>@Route</code></a> or <code>@GET</code>, <code>@POST</code>, …).
|
||||
Each match is constructed with its public no-arg constructor and registered immediately.</div>
|
||||
<dl class="notes">
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="../exceptions/InitializationException.html" title="class in dev.relism.flash.exceptions">InitializationException</a></code> - if the package is empty, not found, or any handler
|
||||
class fails to load or instantiate</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="ctx()">
|
||||
<h3>ctx</h3>
|
||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a></span> <span class="element-name">ctx</span>()</div>
|
||||
<div class="block">Returns the <a href="FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a> for this registrar.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="addRoute(dev.relism.flash.http.HttpMethod,java.lang.String,dev.relism.flash.models.RequestHandler,java.util.List)">
|
||||
<h3>addRoute</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">void</span> <span class="element-name">addRoute</span><wbr><span class="parameters">(<a href="../http/HttpMethod.html" title="enum class in dev.relism.flash.http">HttpMethod</a> method,
|
||||
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> path,
|
||||
<a href="../models/RequestHandler.html" title="class in dev.relism.flash.models">RequestHandler</a> handler,
|
||||
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a>> mw)</span></div>
|
||||
<div class="block">Adds a route immediately to this registrar's deferred compilation list.
|
||||
Subclasses may prepend a namespace prefix and inject scope middlewares before storing.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="addMiddleware(dev.relism.flash.routing.Middleware)">
|
||||
<h3>addMiddleware</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">void</span> <span class="element-name">addMiddleware</span><wbr><span class="parameters">(<a href="../routing/Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a> mw)</span></div>
|
||||
<div class="block">Registers a middleware in this registrar's own scope (global or scope-level).</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="instantiate(java.lang.Class)">
|
||||
<h3>instantiate</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="../models/RequestHandler.html" title="class in dev.relism.flash.models">RequestHandler</a></span> <span class="element-name">instantiate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> cls)</span></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