Google Git
Sign in
apache / tomee-site-pub / 5029b2533c3906b5c1f8300fff30ee925acf2c30 / . / jakartaee-10.0 / javadoc / jakarta / enterprise / inject / build / compatible / spi / InterceptorInfo.html
blob: 8c70d1537ee1960c2598e20ec94c41795026452f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>InterceptorInfo</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="InterceptorInfo";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":6,"i2":6,"i3":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/Messages.html" title="interface in jakarta.enterprise.inject.build.compatible.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html" target="_top">Frames</a></li>
<li><a href="InterceptorInfo.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.enterprise.inject.build.compatible.spi</div>
<h2 title="Interface InterceptorInfo" class="title">Interface InterceptorInfo</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">BeanInfo</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">InterceptorInfo</span>
extends <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">BeanInfo</a></pre>
<div class="block">Interceptors are managed beans annotated <a href="../../../../../../jakarta/interceptor/Interceptor.html" title="annotation in jakarta.interceptor"><code>@Interceptor</code></a>.
An interceptor declares a set of <a href="../../../../../../jakarta/interceptor/InterceptorBinding.html" title="annotation in jakarta.interceptor">interceptor binding annotations</a>,
used to associate the interceptor with target beans. It also declares at most one interceptor method
for each interception type. Interception types are:
<ul>
<li><a href="../../../../../../jakarta/interceptor/AroundInvoke.html" title="annotation in jakarta.interceptor"><code>@AroundInvoke</code></a>: intercept business method invocations,</li>
<li><a href="../../../../../../jakarta/interceptor/AroundConstruct.html" title="annotation in jakarta.interceptor"><code>@AroundConstruct</code></a>: intercept constructor invocations,</li>
<li><a href="../../../../../../jakarta/annotation/PostConstruct.html" title="annotation in jakarta.annotation"><code>@PostConstruct</code></a>: called after the container creates the target instance
and completes dependency injection,</li>
<li><a href="../../../../../../jakarta/annotation/PreDestroy.html" title="annotation in jakarta.annotation"><code>@PreDestroy</code></a>: called before the container destroys the target instance.</li>
</ul>
Finally, an interceptor also needs to declare a <a href="../../../../../../jakarta/annotation/Priority.html" title="annotation in jakarta.annotation"><code>@Priority</code></a> to become enabled.
<p>
Note that this description applies to CDI Lite. There are more ways to declare an interceptor,
but those are only present in CDI Full.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">InterceptorInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html#asInterceptor--">asInterceptor</a></span>()</code>
<div class="block">Returns this bean as an <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">interceptor</a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../../../../../../jakarta/enterprise/lang/model/AnnotationInfo.html" title="interface in jakarta.enterprise.lang.model">AnnotationInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html#interceptorBindings--">interceptorBindings</a></span>()</code>
<div class="block">Returns the set of <a href="../../../../../../jakarta/interceptor/InterceptorBinding.html" title="annotation in jakarta.interceptor">interceptor binding annotations</a>
declared on this interceptor.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html#intercepts-jakarta.enterprise.inject.spi.InterceptionType-">intercepts</a></span>(<a href="../../../../../../jakarta/enterprise/inject/spi/InterceptionType.html" title="enum in jakarta.enterprise.inject.spi">InterceptionType</a>&nbsp;interceptionType)</code>
<div class="block">Returns whether this interceptor declares an interceptor method for given
<a href="../../../../../../jakarta/enterprise/inject/spi/InterceptionType.html" title="enum in jakarta.enterprise.inject.spi">interception type</a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html#isInterceptor--">isInterceptor</a></span>()</code>
<div class="block">Returns whether this bean is an interceptor.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.enterprise.inject.build.compatible.spi.BeanInfo">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.enterprise.inject.build.compatible.spi.<a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">BeanInfo</a></h3>
<code><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#declaringClass--">declaringClass</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#disposer--">disposer</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#injectionPoints--">injectionPoints</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#isAlternative--">isAlternative</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#isClassBean--">isClassBean</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#isProducerField--">isProducerField</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#isProducerMethod--">isProducerMethod</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#isSynthetic--">isSynthetic</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#name--">name</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#priority--">priority</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#producerField--">producerField</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#producerMethod--">producerMethod</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#qualifiers--">qualifiers</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#scope--">scope</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#stereotypes--">stereotypes</a>, <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#types--">types</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="interceptorBindings--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interceptorBindings</h4>
<pre>java.util.Collection&lt;<a href="../../../../../../jakarta/enterprise/lang/model/AnnotationInfo.html" title="interface in jakarta.enterprise.lang.model">AnnotationInfo</a>&gt;&nbsp;interceptorBindings()</pre>
<div class="block">Returns the set of <a href="../../../../../../jakarta/interceptor/InterceptorBinding.html" title="annotation in jakarta.interceptor">interceptor binding annotations</a>
declared on this interceptor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>immutable set of interceptor binding annotations, never <code>null</code></dd>
</dl>
</li>
</ul>
<a name="intercepts-jakarta.enterprise.inject.spi.InterceptionType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>intercepts</h4>
<pre>boolean&nbsp;intercepts(<a href="../../../../../../jakarta/enterprise/inject/spi/InterceptionType.html" title="enum in jakarta.enterprise.inject.spi">InterceptionType</a>&nbsp;interceptionType)</pre>
<div class="block">Returns whether this interceptor declares an interceptor method for given
<a href="../../../../../../jakarta/enterprise/inject/spi/InterceptionType.html" title="enum in jakarta.enterprise.inject.spi">interception type</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interceptionType</code> - the type of interception</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this interceptor declares an interceptor method for given interception type</dd>
</dl>
</li>
</ul>
<a name="isInterceptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInterceptor</h4>
<pre>default&nbsp;boolean&nbsp;isInterceptor()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#isInterceptor--">BeanInfo</a></code></span></div>
<div class="block">Returns whether this bean is an interceptor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#isInterceptor--">isInterceptor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">BeanInfo</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this bean is an interceptor</dd>
</dl>
</li>
</ul>
<a name="asInterceptor--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asInterceptor</h4>
<pre>default&nbsp;<a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">InterceptorInfo</a>&nbsp;asInterceptor()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#asInterceptor--">BeanInfo</a></code></span></div>
<div class="block">Returns this bean as an <a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">interceptor</a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html#asInterceptor--">asInterceptor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi">BeanInfo</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this interceptor, never <code>null</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html" title="interface in jakarta.enterprise.inject.build.compatible.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../jakarta/enterprise/inject/build/compatible/spi/Messages.html" title="interface in jakarta.enterprise.inject.build.compatible.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html" target="_top">Frames</a></li>
<li><a href="InterceptorInfo.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>