Deploying to javadoc from @ Relism/Flash5@6314bcff5f 🚀
This commit is contained in:
Relism
@@ -0,0 +1,335 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang>
|
||||
<head>
|
||||
<!-- Generated by javadoc (21) on Mon May 11 14:20:32 UTC 2026 -->
|
||||
<title>RequestHandler (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.models, class: RequestHandler">
|
||||
<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/RequestHandler.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.models</a></div>
|
||||
<h1 title="Class RequestHandler" class="title">Class RequestHandler</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.models.RequestHandler</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><code><a href="SimpleHandler.html" title="class in dev.relism.flash.models">SimpleHandler</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">RequestHandler</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">Base class for class-based route handlers.
|
||||
|
||||
<p>Declare the route with <a href="../routing/Route.html" title="annotation interface in dev.relism.flash.routing"><code>@Route</code></a> or a shorthand such as
|
||||
<code>@GET("/path")</code>, then register via <a href="../extension/FlashRegistrar.html#scan(java.lang.String)"><code>FlashRegistrar.scan(java.lang.String)</code></a>.
|
||||
For ad-hoc routes use the fluent API (<code>app.get(path, handler)</code> or with middleware).
|
||||
|
||||
<h3 id="lifecycle-heading">Lifecycle</h3>
|
||||
<ol>
|
||||
<li>Instantiation — no-arg constructor (for scan) or manual <code>new Handler(...)</code></li>
|
||||
<li><a href="#bind(dev.relism.flash.extension.FlashContext)"><code>bind(dev.relism.flash.extension.FlashContext)</code></a> — called once by the framework at <code>start()</code>, injects the
|
||||
<a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a> and invokes <a href="#onInit()"><code>onInit()</code></a></li>
|
||||
<li><a href="#handle(dev.relism.flash.models.Request,dev.relism.flash.models.Response)"><code>handle(dev.relism.flash.models.Request, dev.relism.flash.models.Response)</code></a> — called on every matching request (hot-path, zero-alloc)</li>
|
||||
</ol>
|
||||
|
||||
<h3 id="service-access-heading">Service access</h3>
|
||||
Override <a href="#onInit()"><code>onInit()</code></a> to cache services from the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>
|
||||
into private fields. This keeps the hot-path (<code>handle</code>) free of map lookups.
|
||||
|
||||
<pre><code>
|
||||
@GET("/users")
|
||||
public class UserHandler extends RequestHandler {
|
||||
private UserService users;
|
||||
|
||||
@Override protected void onInit() {
|
||||
users = require(UserService.class);
|
||||
}
|
||||
|
||||
@Override public Object handle(Request req, Response res) {
|
||||
return users.findAll();
|
||||
}
|
||||
}
|
||||
</code></pre></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">RequestHandler</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-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-tab4"><code>final void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#bind(dev.relism.flash.extension.FlashContext)" class="member-name-link">bind</a><wbr>(<a href="../extension/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-tab4">
|
||||
<div class="block">Called once by the framework after instantiation, before the first request.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <T> <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><T></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#find(java.lang.Class)" class="member-name-link">find</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><T> type)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Looks up an optional service from the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <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></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#handle(dev.relism.flash.models.Request,dev.relism.flash.models.Response)" class="member-name-link">handle</a><wbr>(<a href="Request.html" title="class in dev.relism.flash.models">Request</a> request,
|
||||
<a href="Response.html" title="class in dev.relism.flash.models">Response</a> response)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Handles an incoming request.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onInit()" class="member-name-link">onInit</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Override to cache services at boot time.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <T> <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><T></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#optional(java.lang.Class)" class="member-name-link">optional</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><T> type)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Looks up an optional service from the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <T> T</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#require(java.lang.Class)" class="member-name-link">require</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><T> type)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Retrieves a required service from the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>.</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>RequestHandler</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RequestHandler</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="bind(dev.relism.flash.extension.FlashContext)">
|
||||
<h3>bind</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">bind</span><wbr><span class="parameters">(<a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a> ctx)</span></div>
|
||||
<div class="block">Called once by the framework after instantiation, before the first request.
|
||||
Injects the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a> and triggers <a href="#onInit()"><code>onInit()</code></a>.
|
||||
|
||||
<p><b>Infrastructure method</b> — do not call from user code.
|
||||
Use <a href="../extension/FlashRegistrar.html#scan(java.lang.String)"><code>FlashRegistrar.scan(java.lang.String)</code></a> instead.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="onInit()">
|
||||
<h3>onInit</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">onInit</span>()</div>
|
||||
<div class="block">Override to cache services at boot time. Called once after <a href="#bind(dev.relism.flash.extension.FlashContext)"><code>bind(dev.relism.flash.extension.FlashContext)</code></a>,
|
||||
before any request reaches this handler.
|
||||
|
||||
<p>Use <a href="#require(java.lang.Class)"><code>require(java.lang.Class<T>)</code></a> and <a href="#find(java.lang.Class)"><code>find(java.lang.Class<T>)</code></a> to retrieve services from the
|
||||
<a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>. Cache them in private fields so the hot-path
|
||||
(<a href="#handle(dev.relism.flash.models.Request,dev.relism.flash.models.Response)"><code>handle(dev.relism.flash.models.Request, dev.relism.flash.models.Response)</code></a>) has zero lookup overhead.
|
||||
|
||||
<p><b>Important:</b> if your class extends another handler base (e.g.
|
||||
<code>JacksonHandler</code>), call <code>super.onInit()</code> first so the parent
|
||||
can initialise its own services.
|
||||
|
||||
<pre><code>
|
||||
@Override protected void onInit() {
|
||||
super.onInit();
|
||||
myService = require(MyService.class);
|
||||
}
|
||||
</code></pre></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="require(java.lang.Class)">
|
||||
<h3>require</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">require</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><T> type)</span></div>
|
||||
<div class="block">Retrieves a required service from the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>.
|
||||
Throws <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link"><code>IllegalStateException</code></a> if the service is not registered or
|
||||
this handler has not been bound yet.
|
||||
|
||||
<p>Typically called inside <a href="#onInit()"><code>onInit()</code></a> to cache the result.</div>
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - the service type</dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>type</code> - the service class</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>the service instance, never null</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="find(java.lang.Class)">
|
||||
<h3>find</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><T></span> <span class="element-name">find</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><T> type)</span></div>
|
||||
<div class="block">Looks up an optional service from the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - the service type</dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>type</code> - the service class</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>the service, or empty if not registered</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="optional(java.lang.Class)">
|
||||
<h3>optional</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><T></span> <span class="element-name">optional</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><T> type)</span></div>
|
||||
<div class="block">Looks up an optional service from the <a href="../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a>.
|
||||
Identical to <a href="#find(java.lang.Class)"><code>find(java.lang.Class<T>)</code></a> — prefer this name for expressive call sites
|
||||
(<code>optional(MyService.class).ifPresent(...)</code>).</div>
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - the service type</dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>type</code> - the service class</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>the service, or empty if not registered</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="handle(dev.relism.flash.models.Request,dev.relism.flash.models.Response)">
|
||||
<h3>handle</h3>
|
||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><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> <span class="element-name">handle</span><wbr><span class="parameters">(<a href="Request.html" title="class in dev.relism.flash.models">Request</a> request,
|
||||
<a href="Response.html" title="class in dev.relism.flash.models">Response</a> response)</span>
|
||||
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
|
||||
<div class="block">Handles an incoming request. The return value determines the response body:
|
||||
return a <a href="Response.html" title="class in dev.relism.flash.models"><code>Response</code></a> to replace the whole response, any other non-null value
|
||||
to set it as the body, or <code>null</code> to leave the response as-is.</div>
|
||||
<dl class="notes">
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd>
|
||||
</dl>
|
||||
</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