Google Git
Sign in
eclipse / www.eclipse.org / jetty / caa63cef1178e162a958a0ce982848d67ac0e16a / . / javadoc / jetty-9 / org / eclipse / jetty / annotations / AnnotationParser.html
blob: ff86ce0bb783631b026390b0aac40848e6ffef83 [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>AnnotationParser (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="AnnotationParser (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/AnnotationParser.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><a href="#nested.class.summary">Nested</a>&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.annotations</a></div>
<h2 title="Class AnnotationParser" class="title">Class AnnotationParser</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.annotations.AnnotationParser</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../osgi/annotations/AnnotationParser.html" title="class in org.eclipse.jetty.osgi.annotations">AnnotationParser</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">AnnotationParser</span>
extends java.lang.Object</pre>
<div class="block">AnnotationParser
<p>
Use asm to scan classes for annotations. A SAX-style parsing is done.
Handlers are registered which will be called back when various types of
entity are encountered, eg a class, a method, a field.
<p>
Handlers are not called back in any particular order and are assumed
to be order-independent.
<p>
As a registered Handler will be called back for each annotation discovered
on a class, a method, a field, the Handler should test to see if the annotation
is one that it is interested in.
<p>
For the servlet spec, we are only interested in annotations on classes, methods and fields,
so the callbacks for handling finding a class, a method a field are themselves
not fully implemented.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.AbstractHandler.html" title="class in org.eclipse.jetty.annotations">AnnotationParser.AbstractHandler</a></span></code></th>
<td class="colLast">
<div class="block">Convenience base class to provide no-ops for all Handler methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.ClassInfo.html" title="class in org.eclipse.jetty.annotations">AnnotationParser.ClassInfo</a></span></code></th>
<td class="colLast">
<div class="block">Immutable information gathered by parsing class header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.FieldInfo.html" title="class in org.eclipse.jetty.annotations">AnnotationParser.FieldInfo</a></span></code></th>
<td class="colLast">
<div class="block">Immutable information gathered by parsing a field on a class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a></span></code></th>
<td class="colLast">
<div class="block">Signature for all handlers that respond to parsing class files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.MethodInfo.html" title="class in org.eclipse.jetty.annotations">AnnotationParser.MethodInfo</a></span></code></th>
<td class="colLast">
<div class="block">Immutable information gathered by parsing a method on a class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.MyClassVisitor.html" title="class in org.eclipse.jetty.annotations">AnnotationParser.MyClassVisitor</a></span></code></th>
<td class="colLast">
<div class="block">ASM visitor for a class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.MyFieldVisitor.html" title="class in org.eclipse.jetty.annotations">AnnotationParser.MyFieldVisitor</a></span></code></th>
<td class="colLast">
<div class="block">An ASM visitor for parsing Fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParser.MyMethodVisitor.html" title="class in org.eclipse.jetty.annotations">AnnotationParser.MyMethodVisitor</a></span></code></th>
<td class="colLast">
<div class="block">ASM Visitor for parsing a method.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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>protected java.util.Map&lt;java.lang.String,&#8203;<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_parsedClassNames">_parsedClassNames</a></span></code></th>
<td class="colLast">
<div class="block">Map of classnames scanned and the first location from which scan occurred</div>
</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()">AnnotationParser</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int)">AnnotationParser</a></span>&#8203;(int&nbsp;javaPlatform)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,int)">AnnotationParser</a></span>&#8203;(int&nbsp;javaPlatform,
int&nbsp;asmVersion)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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="#addParsedClass(java.lang.String,org.eclipse.jetty.util.resource.Resource)">addParsedClass</a></span>&#8203;(java.lang.String&nbsp;classname,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;location)</code></th>
<td class="colLast">
<div class="block">Add a class as having been parsed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParsedLocations(java.lang.String)">getParsedLocations</a></span>&#8203;(java.lang.String&nbsp;classname)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">List of duplicate locations no longer stored</div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidClassFileName(java.lang.String)">isValidClassFileName</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Check that the given path represents a valid class file name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidClassFilePath(java.lang.String)">isValidClassFilePath</a></span>&#8203;(java.lang.String&nbsp;path)</code></th>
<td class="colLast">
<div class="block">Check that the given path does not contain hidden directories</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#normalize(java.lang.String)">normalize</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Convert internal name to simple name</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#normalize(java.lang.String%5B%5D)">normalize</a></span>&#8203;(java.lang.String[]&nbsp;list)</code></th>
<td class="colLast">
<div class="block">Convert internal names to simple names.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,java.lang.Class,boolean)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.Class&lt;?&gt;&nbsp;clazz,
boolean&nbsp;visitSuperClasses)</code></th>
<td class="colLast">
<div class="block">Parse the given class, optionally walking its inheritance hierarchy</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,java.lang.ClassLoader,boolean,boolean)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.ClassLoader&nbsp;loader,
boolean&nbsp;visitParents,
boolean&nbsp;nullInclusive)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,java.lang.String)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.String&nbsp;className)</code></th>
<td class="colLast">
<div class="block">Parse a given class</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,java.lang.String%5B%5D)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.String[]&nbsp;classNames)</code></th>
<td class="colLast">
<div class="block">Parse the given classes</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,java.net.URI)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.net.URI&nbsp;uri)</code></th>
<td class="colLast">
<div class="block">Parse a particular uri</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,java.net.URI%5B%5D)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.net.URI[]&nbsp;uris)</code></th>
<td class="colLast">
<div class="block">Parse classes in the supplied uris.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,java.util.List)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.util.List&lt;java.lang.String&gt;&nbsp;classNames)</code></th>
<td class="colLast">
<div class="block">Parse the given classes</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.util.Set,org.eclipse.jetty.util.resource.Resource)">parse</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;r)</code></th>
<td class="colLast">
<div class="block">Parse a resource</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseDir(java.util.Set,org.eclipse.jetty.util.resource.Resource)">parseDir</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;root)</code></th>
<td class="colLast">
<div class="block">Parse all classes in a directory</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseJar(java.util.Set,org.eclipse.jetty.util.resource.Resource)">parseJar</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;jarResource)</code></th>
<td class="colLast">
<div class="block">Parse a resource that is a jar file.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseJarEntry(java.util.Set,org.eclipse.jetty.util.resource.Resource,org.eclipse.jetty.util.MultiReleaseJarFile.VersionedJarEntry)">parseJarEntry</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;jar,
<a href="../util/MultiReleaseJarFile.VersionedJarEntry.html" title="class in org.eclipse.jetty.util">MultiReleaseJarFile.VersionedJarEntry</a>&nbsp;entry)</code></th>
<td class="colLast">
<div class="block">Parse a single entry in a jar file</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetParsedClasses()">resetParsedClasses</a></span>()</code></th>
<td class="colLast">
<div class="block">Remove any parsed class names.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scanClass(java.util.Set,org.eclipse.jetty.util.resource.Resource,java.io.InputStream)">scanClass</a></span>&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;containingResource,
java.io.InputStream&nbsp;is)</code></th>
<td class="colLast">
<div class="block">Use ASM on a class</div>
</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="_parsedClassNames">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_parsedClassNames</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&gt; _parsedClassNames</pre>
<div class="block">Map of classnames scanned and the first location from which scan occurred</div>
</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="blockList">
<li class="blockList">
<h4>AnnotationParser</h4>
<pre>public&nbsp;AnnotationParser()</pre>
</li>
</ul>
<a id="&lt;init&gt;(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AnnotationParser</h4>
<pre>public&nbsp;AnnotationParser&#8203;(int&nbsp;javaPlatform)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>javaPlatform</code> - The target java version or 0 for the current runtime.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(int,int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AnnotationParser</h4>
<pre>public&nbsp;AnnotationParser&#8203;(int&nbsp;javaPlatform,
int&nbsp;asmVersion)</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="normalize(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalize</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;normalize&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Convert internal name to simple name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the internal name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the simple name</dd>
</dl>
</li>
</ul>
<a id="normalize(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalize</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String[]&nbsp;normalize&#8203;(java.lang.String[]&nbsp;list)</pre>
<div class="block">Convert internal names to simple names.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>list</code> - the list of internal names</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of simple names</dd>
</dl>
</li>
</ul>
<a id="addParsedClass(java.lang.String,org.eclipse.jetty.util.resource.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParsedClass</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addParsedClass&#8203;(java.lang.String&nbsp;classname,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;location)</pre>
<div class="block">Add a class as having been parsed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>classname</code> - the name of the class</dd>
<dd><code>location</code> - the fully qualified location of the class</dd>
</dl>
</li>
</ul>
<a id="getParsedLocations(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParsedLocations</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getParsedLocations&#8203;(java.lang.String&nbsp;classname)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">List of duplicate locations no longer stored</div>
</div>
<div class="block">Get the locations of the given classname. There may be more than one
location if there are duplicates of the same class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>classname</code> - the name of the class</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an immutable list of locations</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.String&nbsp;className)
throws java.lang.Exception</pre>
<div class="block">Parse a given class</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the set of handlers to find class</dd>
<dd><code>className</code> - the class name to parse</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,java.lang.Class,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.Class&lt;?&gt;&nbsp;clazz,
boolean&nbsp;visitSuperClasses)
throws java.lang.Exception</pre>
<div class="block">Parse the given class, optionally walking its inheritance hierarchy</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for class in</dd>
<dd><code>clazz</code> - the class to look for</dd>
<dd><code>visitSuperClasses</code> - if true, also visit super classes for parse</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse class</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.String[]&nbsp;classNames)
throws java.lang.Exception</pre>
<div class="block">Parse the given classes</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the set of handlers to look for class in</dd>
<dd><code>classNames</code> - the class name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.util.List&lt;java.lang.String&gt;&nbsp;classNames)
throws java.lang.Exception</pre>
<div class="block">Parse the given classes</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the set of handlers to look for class in</dd>
<dd><code>classNames</code> - the class names</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parseDir(java.util.Set,org.eclipse.jetty.util.resource.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseDir</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;parseDir&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;root)
throws java.lang.Exception</pre>
<div class="block">Parse all classes in a directory</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the set of handlers to look for classes in</dd>
<dd><code>root</code> - the resource directory to look for classes</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,java.lang.ClassLoader,boolean,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.lang.ClassLoader&nbsp;loader,
boolean&nbsp;visitParents,
boolean&nbsp;nullInclusive)
throws java.lang.Exception</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Parse classes in the supplied classloader.
Only class files in jar files will be scanned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for classes in</dd>
<dd><code>loader</code> - the classloader for the classes</dd>
<dd><code>visitParents</code> - if true, visit parent classloaders too</dd>
<dd><code>nullInclusive</code> - if true, an empty pattern means all names match, if false, none match</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,java.net.URI[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.net.URI[]&nbsp;uris)
throws java.lang.Exception</pre>
<div class="block">Parse classes in the supplied uris.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for classes in</dd>
<dd><code>uris</code> - the uris for the jars</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
java.net.URI&nbsp;uri)
throws java.lang.Exception</pre>
<div class="block">Parse a particular uri</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for classes in</dd>
<dd><code>uri</code> - the uri for the jar</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parse(java.util.Set,org.eclipse.jetty.util.resource.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;r)
throws java.lang.Exception</pre>
<div class="block">Parse a resource</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for classes in</dd>
<dd><code>r</code> - the resource to parse</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parseJar(java.util.Set,org.eclipse.jetty.util.resource.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseJar</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;parseJar&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;jarResource)
throws java.lang.Exception</pre>
<div class="block">Parse a resource that is a jar file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for classes in</dd>
<dd><code>jarResource</code> - the jar resource to parse</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="parseJarEntry(java.util.Set,org.eclipse.jetty.util.resource.Resource,org.eclipse.jetty.util.MultiReleaseJarFile.VersionedJarEntry)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseJarEntry</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;parseJarEntry&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;jar,
<a href="../util/MultiReleaseJarFile.VersionedJarEntry.html" title="class in org.eclipse.jetty.util">MultiReleaseJarFile.VersionedJarEntry</a>&nbsp;entry)
throws java.lang.Exception</pre>
<div class="block">Parse a single entry in a jar file</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for classes in</dd>
<dd><code>entry</code> - the entry in the potentially MultiRelease jar resource to parse</dd>
<dd><code>jar</code> - the jar file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="scanClass(java.util.Set,org.eclipse.jetty.util.resource.Resource,java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scanClass</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;scanClass&#8203;(java.util.Set&lt;? extends <a href="AnnotationParser.Handler.html" title="interface in org.eclipse.jetty.annotations">AnnotationParser.Handler</a>&gt;&nbsp;handlers,
<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;containingResource,
java.io.InputStream&nbsp;is)
throws java.io.IOException</pre>
<div class="block">Use ASM on a class</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handlers</code> - the handlers to look for classes in</dd>
<dd><code>containingResource</code> - the dir or jar that the class is contained within, can be null if not known</dd>
<dd><code>is</code> - the input stream to parse</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to parse</dd>
</dl>
</li>
</ul>
<a id="resetParsedClasses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetParsedClasses</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;resetParsedClasses()</pre>
<div class="block">Remove any parsed class names.</div>
</li>
</ul>
<a id="isValidClassFileName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidClassFileName</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isValidClassFileName&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Check that the given path represents a valid class file name.
The check is fairly cursory, checking that:
<ul>
<li> the name ends with .class</li>
<li> it isn't a dot file or in a hidden directory </li>
<li> the name of the class at least begins with a valid identifier for a class name </li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the class file name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the class file name is valid</dd>
</dl>
</li>
</ul>
<a id="isValidClassFilePath(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isValidClassFilePath</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isValidClassFilePath&#8203;(java.lang.String&nbsp;path)</pre>
<div class="block">Check that the given path does not contain hidden directories</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - the class file path</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the class file path is valid</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/AnnotationParser.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><a href="#nested.class.summary">Nested</a>&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>