blob: ae97e1120a8fdf764786c7bb9af7b99849cefe0b [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>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CustomAnnotationProcessor (Apache Axis2)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CustomAnnotationProcessor (Apache Axis2)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/CustomAnnotationProcessor.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">
<li><a href="../../../../../../org/apache/axis2/jaxws/description/builder/CustomAnnotationInstance.html" title="interface in org.apache.axis2.jaxws.description.builder"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/axis2/jaxws/description/builder/DescriptionBuilderComposite.html" title="class in org.apache.axis2.jaxws.description.builder"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/jaxws/description/builder/CustomAnnotationProcessor.html" target="_top">Frames</a></li>
<li><a href="CustomAnnotationProcessor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All 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">org.apache.axis2.jaxws.description.builder</div>
<h2 title="Interface CustomAnnotationProcessor" class="title">Interface CustomAnnotationProcessor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">CustomAnnotationProcessor</span></pre>
<div class="block">This interface represents processors that will be used to
handle CustomAnnotationInstances that are added to the MDQ layer
by the uaser. These processors will also be registered with
MDQ, and they will be called by MDQ as needed.</div>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/description/builder/CustomAnnotationProcessor.html#getAnnotationInstanceClassName()">getAnnotationInstanceClassName</a></strong>()</code>
<div class="block">This method returns the fully qualifed name of the
CustomAnnotationInstance class that this processor
is responsible for handling.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/description/builder/CustomAnnotationProcessor.html#processTypeLevelAnnotation(org.apache.axis2.jaxws.description.EndpointDescription, org.apache.axis2.jaxws.description.builder.CustomAnnotationInstance)">processTypeLevelAnnotation</a></strong>(<a href="../../../../../../org/apache/axis2/jaxws/description/EndpointDescription.html" title="interface in org.apache.axis2.jaxws.description">EndpointDescription</a>&nbsp;ed,
<a href="../../../../../../org/apache/axis2/jaxws/description/builder/CustomAnnotationInstance.html" title="interface in org.apache.axis2.jaxws.description.builder">CustomAnnotationInstance</a>&nbsp;annotation)</code>
<div class="block">This method will be called to process an annotation type
recognized by this processor that was found at the type
level.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/description/builder/CustomAnnotationProcessor.html#setAnnotationInstanceClassName(java.lang.String)">setAnnotationInstanceClassName</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;annotationInstanceClassName)</code>
<div class="block">This method sets the fully qualifed name of the
CustomAnnotationInstance class that this processor
is responsible for handling.</div>
</td>
</tr>
</table>
</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="setAnnotationInstanceClassName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAnnotationInstanceClassName</h4>
<pre>void&nbsp;setAnnotationInstanceClassName(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;annotationInstanceClassName)</pre>
<div class="block">This method sets the fully qualifed name of the
CustomAnnotationInstance class that this processor
is responsible for handling.</div>
</li>
</ul>
<a name="getAnnotationInstanceClassName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAnnotationInstanceClassName</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAnnotationInstanceClassName()</pre>
<div class="block">This method returns the fully qualifed name of the
CustomAnnotationInstance class that this processor
is responsible for handling.</div>
</li>
</ul>
<a name="processTypeLevelAnnotation(org.apache.axis2.jaxws.description.EndpointDescription, org.apache.axis2.jaxws.description.builder.CustomAnnotationInstance)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>processTypeLevelAnnotation</h4>
<pre>void&nbsp;processTypeLevelAnnotation(<a href="../../../../../../org/apache/axis2/jaxws/description/EndpointDescription.html" title="interface in org.apache.axis2.jaxws.description">EndpointDescription</a>&nbsp;ed,
<a href="../../../../../../org/apache/axis2/jaxws/description/builder/CustomAnnotationInstance.html" title="interface in org.apache.axis2.jaxws.description.builder">CustomAnnotationInstance</a>&nbsp;annotation)</pre>
<div class="block">This method will be called to process an annotation type
recognized by this processor that was found at the type
level.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ed</code> - - EndpointDescription that the annotation was associated with</dd><dd><code>annotation</code> - - The CustomAnnotationInstance that should be processed
by this processor</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/CustomAnnotationProcessor.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">
<li><a href="../../../../../../org/apache/axis2/jaxws/description/builder/CustomAnnotationInstance.html" title="interface in org.apache.axis2.jaxws.description.builder"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/axis2/jaxws/description/builder/DescriptionBuilderComposite.html" title="class in org.apache.axis2.jaxws.description.builder"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/jaxws/description/builder/CustomAnnotationProcessor.html" target="_top">Frames</a></li>
<li><a href="CustomAnnotationProcessor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All 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 ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>