2022-12-14 17:15:42 +00:00
<!DOCTYPE HTML>
< html lang = "en" >
< head >
2022-12-15 05:08:12 +00:00
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
2022-12-14 17:15:42 +00:00
< title > Context< / 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 = "2022-12-14" >
< meta name = "description" content = "declaration: package: io.github.simplexdevelopment.api, interface: Context" >
< 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" >
< 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 = "../../../../script-dir/jquery-3.5.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" > v a r e v e n R o w C o l o r = " e v e n - r o w - c o l o r " ;
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
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" >
< 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 = "package-tree.html" > Tree< / a > < / li >
2022-12-14 18:57:45 +00:00
< li > < a href = "../../../../deprecated-list.html" > Deprecated< / a > < / li >
2022-12-14 17:15:42 +00:00
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html#class" > Help< / a > < / li >
< / ul >
< / div >
< div class = "sub-nav" >
< div >
< 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" > < label for = "search-input" > SEARCH:< / label >
< input type = "text" id = "search-input" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset-button" value = "reset" disabled = "disabled" >
< / 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" > io.github.simplexdevelopment.api< / a > < / div >
< h1 title = "Interface Context" class = "title" > Interface Context< S> < / h1 >
< / div >
< section class = "class-description" id = "class-description" >
2022-12-14 18:57:45 +00:00
< dl class = "notes" >
2022-12-15 05:08:12 +00:00
< dt > Type Parameters:< / dt >
< dd > < code > S< / code > - Any object type to wrap with this class.< / dd >
2022-12-14 18:57:45 +00:00
< / dl >
2022-12-14 17:15:42 +00:00
< hr >
< div class = "type-signature" > < span class = "modifiers" > public interface < / span > < span class = "element-name type-name-label" > Context< S> < / span > < / div >
2022-12-15 05:08:12 +00:00
< div class = "block" > A glorified wrapper class which collects an element and abstracts it behind the Reactor API.< / div >
2022-12-14 17:15:42 +00:00
< / 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-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-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" >
< div class = "summary-table three-column-summary" aria-labelledby = "method-summary-table-tab0" >
< 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 >
2022-12-14 18:57:45 +00:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > @Nullable < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title = "class or interface in java.util" class = "external-link" > Collection< / a > < < a href = "Context.html" title = "type parameter in Context" > S< / a > > < / code > < / div >
2022-12-14 17:15:42 +00:00
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#contextCollection()" class = "member-name-link" > contextCollection< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
2022-12-14 18:57:45 +00:00
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > default @Nullable reactor.core.publisher.Flux< < a href = "Context.html" title = "type parameter in Context" > S< / a > > < / code > < / div >
2022-12-14 17:15:42 +00:00
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > < a href = "#fluxFromCollection()" class = "member-name-link" > fluxFromCollection< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < / div >
2022-12-14 18:57:45 +00:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > @NotNull reactor.core.publisher.Mono< < a href = "Context.html" title = "type parameter in Context" > S< / a > > < / code > < / div >
2022-12-14 17:15:42 +00:00
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getContext()" class = "member-name-link" > getContext< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
2022-12-14 18:57:45 +00:00
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > @NotNull reactor.core.publisher.Mono< < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title = "class or interface in java.lang" class = "external-link" > Void< / a > > < / code > < / div >
2022-12-14 17:15:42 +00:00
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#setContext(S)" class = "member-name-link" > setContext< / a > < wbr > (< a href = "Context.html" title = "type parameter in Context" > S< / a > context)< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / 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 = "getContext()" >
< h3 > getContext< / h3 >
2022-12-14 18:57:45 +00:00
< div class = "member-signature" > < span class = "annotations" > @NotNull
< / span > < span class = "return-type" > @NotNull reactor.core.publisher.Mono< < a href = "Context.html" title = "type parameter in Context" > S< / a > > < / span > < span class = "element-name" > getContext< / span > ()< / div >
2022-12-14 17:15:42 +00:00
< dl class = "notes" >
< dt > Returns:< / dt >
< dd > A Mono object which contains a single element represented by the definer of this Context class.< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "setContext(S)" >
< h3 id = "setContext(java.lang.Object)" > setContext< / h3 >
2022-12-14 18:57:45 +00:00
< div class = "member-signature" > < span class = "annotations" > @NotNull
< / span > < span class = "return-type" > @NotNull reactor.core.publisher.Mono< < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title = "class or interface in java.lang" class = "external-link" > Void< / a > > < / span > < span class = "element-name" > setContext< / span > < wbr > < span class = "parameters" > (< a href = "Context.html" title = "type parameter in Context" > S< / a > context)< / span > < / div >
2022-12-14 17:15:42 +00:00
< dl class = "notes" >
< dt > Parameters:< / dt >
< dd > < code > context< / code > - A separate (or identical) object identified by the definer of this Context class.< / dd >
< dt > Returns:< / dt >
< dd > A Mono object which can be used to set the element of this Context class in a non-blocking manner.< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "contextCollection()" >
< h3 > contextCollection< / h3 >
2022-12-14 18:57:45 +00:00
< div class = "member-signature" > < span class = "annotations" > @Nullable
< / span > < span class = "return-type" > @Nullable < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title = "class or interface in java.util" class = "external-link" > Collection< / a > < < a href = "Context.html" title = "type parameter in Context" > S< / a > > < / span > < span class = "element-name" > contextCollection< / span > ()< / div >
2022-12-14 17:15:42 +00:00
< dl class = "notes" >
< dt > Returns:< / dt >
< dd > A collection of objects related to the definer of this Context class.< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "fluxFromCollection()" >
< h3 > fluxFromCollection< / h3 >
2022-12-14 18:57:45 +00:00
< div class = "member-signature" > < span class = "annotations" > @Nullable
< / span > < span class = "modifiers" > default< / span > < span class = "return-type" > @Nullable reactor.core.publisher.Flux< < a href = "Context.html" title = "type parameter in Context" > S< / a > > < / span > < span class = "element-name" > fluxFromCollection< / span > ()< / div >
2022-12-14 17:15:42 +00:00
< dl class = "notes" >
< dt > Returns:< / dt >
< dd > A Flux object which contains the values of the < a href = "#contextCollection()" > < code > contextCollection()< / code > < / a > , for non-blocking interpretation.< / dd >
< / dl >
< / section >
< / li >
< / ul >
< / section >
< / li >
< / ul >
< / section >
<!-- ========= END OF CLASS DATA ========= -->
< / main >
< / div >
< / div >
< / body >
< / html >
