blob: a01b834719c55eb4170339614c4640ab87b69ac5 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>LifeCycleCallbackCollection (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LifeCycleCallbackCollection (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LifeCycleCallbackCollection.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.plus.annotation</a></div>
<h2 title="Class LifeCycleCallbackCollection" class="title">Class LifeCycleCallbackCollection</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.plus.annotation.LifeCycleCallbackCollection</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">LifeCycleCallbackCollection</span>
extends java.lang.Object</pre>
<div class="block">LifeCycleCallbackCollection
This class collects the classes and methods that have been configured
in web.xml with postconstruct/predestroy callbacks, or that contain the
equivalent annotations. It is also responsible for calling the
callbacks.
This class is not threadsafe for concurrent modifications, but is
threadsafe for reading with concurrent modifications.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LIFECYCLE_CALLBACK_COLLECTION">LIFECYCLE_CALLBACK_COLLECTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">LifeCycleCallbackCollection</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(org.eclipse.jetty.plus.annotation.LifeCycleCallback)">add</a></span>&#8203;(<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Add a Callback to the list of callbacks.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callPostConstructCallback(java.lang.Object)">callPostConstructCallback</a></span>&#8203;(java.lang.Object&nbsp;o)</code></th>
<td class="colLast">
<div class="block">Call the method, if one exists, that is annotated with <code>&#064;PostConstruct</code>
or with <code>&lt;post-construct&gt;</code> in web.xml</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callPreDestroyCallback(java.lang.Object)">callPreDestroyCallback</a></span>&#8203;(java.lang.Object&nbsp;o)</code></th>
<td class="colLast">
<div class="block">Call the method, if one exists, that is annotated with <code>&#064;PreDestroy</code>
or with <code>&lt;pre-destroy&gt;</code> in web.xml</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPostConstructCallbackMap()">getPostConstructCallbackMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Generate a read-only view of the post-construct callbacks</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPostConstructCallbacks()">getPostConstructCallbacks</a></span>()</code></th>
<td class="colLast">
<div class="block">Amalgamate all post-construct callbacks and return a read only set</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPostConstructCallbacks(java.lang.Object)">getPostConstructCallbacks</a></span>&#8203;(java.lang.Object&nbsp;o)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPreDestroyCallbackMap()">getPreDestroyCallbackMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Generate a read-only view of the pre-destroy callbacks</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPreDestroyCallbacks()">getPreDestroyCallbacks</a></span>()</code></th>
<td class="colLast">
<div class="block">Amalgamate all pre-destroy callbacks and return a read only set</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPreDestroyCallbacks(java.lang.Object)">getPreDestroyCallbacks</a></span>&#8203;(java.lang.Object&nbsp;o)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="LIFECYCLE_CALLBACK_COLLECTION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LIFECYCLE_CALLBACK_COLLECTION</h4>
<pre>public static final&nbsp;java.lang.String LIFECYCLE_CALLBACK_COLLECTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.plus.annotation.LifeCycleCallbackCollection.LIFECYCLE_CALLBACK_COLLECTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LifeCycleCallbackCollection</h4>
<pre>public&nbsp;LifeCycleCallbackCollection()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="add(org.eclipse.jetty.plus.annotation.LifeCycleCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;add&#8203;(<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&nbsp;callback)</pre>
<div class="block">Add a Callback to the list of callbacks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callback</code> - the callback</dd>
</dl>
</li>
</ul>
<a id="getPreDestroyCallbacks(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreDestroyCallbacks</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&nbsp;getPreDestroyCallbacks&#8203;(java.lang.Object&nbsp;o)</pre>
</li>
</ul>
<a id="getPostConstructCallbacks(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPostConstructCallbacks</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&nbsp;getPostConstructCallbacks&#8203;(java.lang.Object&nbsp;o)</pre>
</li>
</ul>
<a id="callPostConstructCallback(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callPostConstructCallback</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;callPostConstructCallback&#8203;(java.lang.Object&nbsp;o)
throws java.lang.Exception</pre>
<div class="block">Call the method, if one exists, that is annotated with <code>&#064;PostConstruct</code>
or with <code>&lt;post-construct&gt;</code> in web.xml</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>o</code> - the object on which to attempt the callback</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to call <a href="PostConstructCallback.html" title="class in org.eclipse.jetty.plus.annotation"><code>PostConstructCallback</code></a></dd>
</dl>
</li>
</ul>
<a id="callPreDestroyCallback(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callPreDestroyCallback</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;callPreDestroyCallback&#8203;(java.lang.Object&nbsp;o)
throws java.lang.Exception</pre>
<div class="block">Call the method, if one exists, that is annotated with <code>&#064;PreDestroy</code>
or with <code>&lt;pre-destroy&gt;</code> in web.xml</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>o</code> - the object on which to attempt the callback</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to call <a href="PreDestroyCallback.html" title="class in org.eclipse.jetty.plus.annotation"><code>PreDestroyCallback</code></a></dd>
</dl>
</li>
</ul>
<a id="getPostConstructCallbackMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPostConstructCallbackMap</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&gt;&nbsp;getPostConstructCallbackMap()</pre>
<div class="block">Generate a read-only view of the post-construct callbacks</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the map of <a href="PostConstructCallback.html" title="class in org.eclipse.jetty.plus.annotation"><code>PostConstructCallback</code></a>s</dd>
</dl>
</li>
</ul>
<a id="getPreDestroyCallbackMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreDestroyCallbackMap</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.util.Set&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&gt;&nbsp;getPreDestroyCallbackMap()</pre>
<div class="block">Generate a read-only view of the pre-destroy callbacks</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the map of <a href="PreDestroyCallback.html" title="class in org.eclipse.jetty.plus.annotation"><code>PreDestroyCallback</code></a>s</dd>
</dl>
</li>
</ul>
<a id="getPostConstructCallbacks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPostConstructCallbacks</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&nbsp;getPostConstructCallbacks()</pre>
<div class="block">Amalgamate all post-construct callbacks and return a read only set</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the collection of <a href="PostConstructCallback.html" title="class in org.eclipse.jetty.plus.annotation"><code>PostConstructCallback</code></a>s</dd>
</dl>
</li>
</ul>
<a id="getPreDestroyCallbacks()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPreDestroyCallbacks</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;<a href="LifeCycleCallback.html" title="class in org.eclipse.jetty.plus.annotation">LifeCycleCallback</a>&gt;&nbsp;getPreDestroyCallbacks()</pre>
<div class="block">Amalgamate all pre-destroy callbacks and return a read only set</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the collection of <a href="PreDestroyCallback.html" title="class in org.eclipse.jetty.plus.annotation"><code>PreDestroyCallback</code></a>s</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LifeCycleCallbackCollection.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>