1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (version 1.7.0_79) on Tue May 12 22:00:47 CEST 2015 -->
6 <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7 <title>AnnotationDB (scannotation 1.0.4 API)</title>
8 <meta name="date" content="2015-05-12">
9 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
12 <script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
14 parent.document.title="AnnotationDB (scannotation 1.0.4 API)";
19 <div>JavaScript is disabled on your browser.</div>
21 <!-- ========= START OF TOP NAVBAR ======= -->
22 <div class="topNav"><a name="navbar_top">
24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
27 <ul class="navList" title="Navigation">
28 <li><a href="../../overview-summary.html">Overview</a></li>
29 <li><a href="package-summary.html">Package</a></li>
30 <li class="navBarCell1Rev">Class</li>
31 <li><a href="class-use/AnnotationDB.html">Use</a></li>
32 <li><a href="package-tree.html">Tree</a></li>
33 <li><a href="../../deprecated-list.html">Deprecated</a></li>
34 <li><a href="../../index-all.html">Index</a></li>
35 <li><a href="../../help-doc.html">Help</a></li>
41 <li><a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation"><span class="strong">Next Class</span></a></li>
44 <li><a href="../../index.html?org/scannotation/AnnotationDB.html" target="_top">Frames</a></li>
45 <li><a href="AnnotationDB.html" target="_top">No Frames</a></li>
47 <ul class="navList" id="allclasses_navbar_top">
48 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
51 <script type="text/javascript"><!--
52 allClassesLink = document.getElementById("allclasses_navbar_top");
54 allClassesLink.style.display = "block";
57 allClassesLink.style.display = "none";
63 <ul class="subNavList">
64 <li>Summary: </li>
65 <li><a href="#nested_class_summary">Nested</a> | </li>
66 <li><a href="#field_summary">Field</a> | </li>
67 <li><a href="#constructor_summary">Constr</a> | </li>
68 <li><a href="#method_summary">Method</a></li>
70 <ul class="subNavList">
71 <li>Detail: </li>
72 <li><a href="#field_detail">Field</a> | </li>
73 <li><a href="#constructor_detail">Constr</a> | </li>
74 <li><a href="#method_detail">Method</a></li>
77 <a name="skip-navbar_top">
80 <!-- ========= END OF TOP NAVBAR ========= -->
81 <!-- ======== START OF CLASS DATA ======== -->
83 <div class="subTitle">org.scannotation</div>
84 <h2 title="Class AnnotationDB" class="title">Class AnnotationDB</h2>
86 <div class="contentContainer">
87 <ul class="inheritance">
88 <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
90 <ul class="inheritance">
91 <li>org.scannotation.AnnotationDB</li>
95 <div class="description">
96 <ul class="blockList">
97 <li class="blockList">
99 <dt>All Implemented Interfaces:</dt>
100 <dd><a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
104 <pre>public class <span class="strong">AnnotationDB</span>
105 extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
106 implements <a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
107 <div class="block">The class allows you to scan an arbitrary set of "archives" for .class files. These class files
108 are parsed to see what annotations they use. Two indexes are created. The javax, java, sun, com.sun, and javassist
109 packages will not be scanned by default.
111 One is a map of annotations and what classes
112 use those annotations. This could be used, for example, by an EJB deployer to find all the EJBs contained
115 Another is a mpa of classes and what annotations those classes use.</div>
116 <dl><dt><span class="strong">Version:</span></dt>
117 <dd>$Revision: 1 $</dd>
118 <dt><span class="strong">Author:</span></dt>
119 <dd><a href="mailto:bill@burkecentral.com">Bill Burke</a></dd>
120 <dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#org.scannotation.AnnotationDB">Serialized Form</a></dd></dl>
124 <div class="summary">
125 <ul class="blockList">
126 <li class="blockList">
127 <!-- ======== NESTED CLASS SUMMARY ======== -->
128 <ul class="blockList">
129 <li class="blockList"><a name="nested_class_summary">
132 <h3>Nested Class Summary</h3>
133 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
134 <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
136 <th class="colFirst" scope="col">Modifier and Type</th>
137 <th class="colLast" scope="col">Class and Description</th>
139 <tr class="altColor">
140 <td class="colFirst"><code>class </code></td>
141 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation">AnnotationDB.CrossReferenceException</a></strong></code> </td>
146 <!-- =========== FIELD SUMMARY =========== -->
147 <ul class="blockList">
148 <li class="blockList"><a name="field_summary">
151 <h3>Field Summary</h3>
152 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
153 <caption><span>Fields</span><span class="tabEnd"> </span></caption>
155 <th class="colFirst" scope="col">Modifier and Type</th>
156 <th class="colLast" scope="col">Field and Description</th>
158 <tr class="altColor">
159 <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td>
160 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#annotationIndex">annotationIndex</a></strong></code> </td>
162 <tr class="rowColor">
163 <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td>
164 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#classIndex">classIndex</a></strong></code> </td>
166 <tr class="altColor">
167 <td class="colFirst"><code>protected boolean</code></td>
168 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#ignoreBadURLs">ignoreBadURLs</a></strong></code> </td>
170 <tr class="rowColor">
171 <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
172 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#ignoredPackages">ignoredPackages</a></strong></code> </td>
174 <tr class="altColor">
175 <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td>
176 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#implementsIndex">implementsIndex</a></strong></code> </td>
178 <tr class="rowColor">
179 <td class="colFirst"><code>protected boolean</code></td>
180 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanClassAnnotations">scanClassAnnotations</a></strong></code> </td>
182 <tr class="altColor">
183 <td class="colFirst"><code>protected boolean</code></td>
184 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanFieldAnnotations">scanFieldAnnotations</a></strong></code> </td>
186 <tr class="rowColor">
187 <td class="colFirst"><code>protected boolean</code></td>
188 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanMethodAnnotations">scanMethodAnnotations</a></strong></code> </td>
190 <tr class="altColor">
191 <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
192 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanPackages">scanPackages</a></strong></code> </td>
194 <tr class="rowColor">
195 <td class="colFirst"><code>protected boolean</code></td>
196 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanParameterAnnotations">scanParameterAnnotations</a></strong></code> </td>
201 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
202 <ul class="blockList">
203 <li class="blockList"><a name="constructor_summary">
206 <h3>Constructor Summary</h3>
207 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
208 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
210 <th class="colOne" scope="col">Constructor and Description</th>
212 <tr class="altColor">
213 <td class="colOne"><code><strong><a href="../../org/scannotation/AnnotationDB.html#AnnotationDB()">AnnotationDB</a></strong>()</code> </td>
218 <!-- ========== METHOD SUMMARY =========== -->
219 <ul class="blockList">
220 <li class="blockList"><a name="method_summary">
223 <h3>Method Summary</h3>
224 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
225 <caption><span>Methods</span><span class="tabEnd"> </span></caption>
227 <th class="colFirst" scope="col">Modifier and Type</th>
228 <th class="colLast" scope="col">Method and Description</th>
230 <tr class="altColor">
231 <td class="colFirst"><code>void</code></td>
232 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#addIgnoredPackages(java.lang.String...)">addIgnoredPackages</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... ignored)</code> </td>
234 <tr class="rowColor">
235 <td class="colFirst"><code>void</code></td>
236 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#crossReferenceImplementedInterfaces()">crossReferenceImplementedInterfaces</a></strong>()</code>
237 <div class="block">Sometimes you want to see if a particular class implements an interface with certain annotations
238 After you have loaded all your classpaths with the scanArchive() method, call this method to cross reference
239 a class's implemented interfaces.</div>
242 <tr class="altColor">
243 <td class="colFirst"><code>void</code></td>
244 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#crossReferenceMetaAnnotations()">crossReferenceMetaAnnotations</a></strong>()</code>
245 <div class="block">This method will cross reference annotations in the annotation index with any meta-annotations that they have
246 and create additional entries as needed.</div>
249 <tr class="rowColor">
250 <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td>
251 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#getAnnotationIndex()">getAnnotationIndex</a></strong>()</code>
252 <div class="block">returns a map keyed by the fully qualified string name of a annotation class.</div>
255 <tr class="altColor">
256 <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td>
257 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#getClassIndex()">getClassIndex</a></strong>()</code>
258 <div class="block">returns a map keyed by the list of classes scanned.</div>
261 <tr class="rowColor">
262 <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
263 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#getIgnoredPackages()">getIgnoredPackages</a></strong>()</code> </td>
265 <tr class="altColor">
266 <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
267 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#getScanPackages()">getScanPackages</a></strong>()</code> </td>
269 <tr class="rowColor">
270 <td class="colFirst"><code>void</code></td>
271 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#outputAnnotationIndex(java.io.PrintWriter)">outputAnnotationIndex</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> writer)</code>
272 <div class="block">Prints out annotationIndex</div>
275 <tr class="altColor">
276 <td class="colFirst"><code>protected void</code></td>
277 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#populate(javassist.bytecode.annotation.Annotation[],%20java.lang.String)">populate</a></strong>(javassist.bytecode.annotation.Annotation[] annotations,
278 <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</code> </td>
280 <tr class="rowColor">
281 <td class="colFirst"><code>void</code></td>
282 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanArchives(java.net.URL...)">scanArchives</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>... urls)</code>
283 <div class="block">Scan a url that represents an "archive" this is a classpath directory or jar file</div>
286 <tr class="altColor">
287 <td class="colFirst"><code>protected void</code></td>
288 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanClass(javassist.bytecode.ClassFile)">scanClass</a></strong>(javassist.bytecode.ClassFile cf)</code> </td>
290 <tr class="rowColor">
291 <td class="colFirst"><code>void</code></td>
292 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanClass(java.io.InputStream)">scanClass</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> bits)</code>
293 <div class="block">Parse a .class file for annotations</div>
296 <tr class="altColor">
297 <td class="colFirst"><code>protected void</code></td>
298 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanFields(javassist.bytecode.ClassFile)">scanFields</a></strong>(javassist.bytecode.ClassFile cf)</code> </td>
300 <tr class="rowColor">
301 <td class="colFirst"><code>protected void</code></td>
302 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#scanMethods(javassist.bytecode.ClassFile)">scanMethods</a></strong>(javassist.bytecode.ClassFile cf)</code>
303 <div class="block">Scanns both the method and its parameters for annotations.</div>
306 <tr class="altColor">
307 <td class="colFirst"><code>void</code></td>
308 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#setIgnoreBadURLs(boolean)">setIgnoreBadURLs</a></strong>(boolean ignoreBadURLs)</code>
309 <div class="block">Whether or not you want AnnotationDB to ignore bad URLs passed to scanArchives.</div>
312 <tr class="rowColor">
313 <td class="colFirst"><code>void</code></td>
314 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#setIgnoredPackages(java.lang.String[])">setIgnoredPackages</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] ignoredPackages)</code>
315 <div class="block">Override/overwrite any ignored packages</div>
318 <tr class="altColor">
319 <td class="colFirst"><code>void</code></td>
320 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#setScanClassAnnotations(boolean)">setScanClassAnnotations</a></strong>(boolean scanClassAnnotations)</code>
321 <div class="block">Whether or not you want AnnotationDB to scan for class level annotations</div>
324 <tr class="rowColor">
325 <td class="colFirst"><code>void</code></td>
326 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#setScanFieldAnnotations(boolean)">setScanFieldAnnotations</a></strong>(boolean scanFieldAnnotations)</code>
327 <div class="block">Whether or not you want AnnotationDB to scan for parameter level annotations</div>
330 <tr class="altColor">
331 <td class="colFirst"><code>void</code></td>
332 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#setScanMethodAnnotations(boolean)">setScanMethodAnnotations</a></strong>(boolean scanMethodAnnotations)</code>
333 <div class="block">Wheter or not you want AnnotationDB to scan for method level annotations</div>
336 <tr class="rowColor">
337 <td class="colFirst"><code>void</code></td>
338 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#setScanPackages(java.lang.String[])">setScanPackages</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] scanPackages)</code>
339 <div class="block">Set explicit packages to scan.</div>
342 <tr class="altColor">
343 <td class="colFirst"><code>void</code></td>
344 <td class="colLast"><code><strong><a href="../../org/scannotation/AnnotationDB.html#setScanParameterAnnotations(boolean)">setScanParameterAnnotations</a></strong>(boolean scanParameterAnnotations)</code>
345 <div class="block">Whether or not you want AnnotationDB to scan for parameter level annotations</div>
349 <ul class="blockList">
350 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
353 <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
354 <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
361 <div class="details">
362 <ul class="blockList">
363 <li class="blockList">
364 <!-- ============ FIELD DETAIL =========== -->
365 <ul class="blockList">
366 <li class="blockList"><a name="field_detail">
369 <h3>Field Detail</h3>
370 <a name="annotationIndex">
373 <ul class="blockList">
374 <li class="blockList">
375 <h4>annotationIndex</h4>
376 <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> annotationIndex</pre>
379 <a name="implementsIndex">
382 <ul class="blockList">
383 <li class="blockList">
384 <h4>implementsIndex</h4>
385 <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> implementsIndex</pre>
388 <a name="classIndex">
391 <ul class="blockList">
392 <li class="blockList">
394 <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> classIndex</pre>
397 <a name="scanClassAnnotations">
400 <ul class="blockList">
401 <li class="blockList">
402 <h4>scanClassAnnotations</h4>
403 <pre>protected transient boolean scanClassAnnotations</pre>
406 <a name="scanMethodAnnotations">
409 <ul class="blockList">
410 <li class="blockList">
411 <h4>scanMethodAnnotations</h4>
412 <pre>protected transient boolean scanMethodAnnotations</pre>
415 <a name="scanParameterAnnotations">
418 <ul class="blockList">
419 <li class="blockList">
420 <h4>scanParameterAnnotations</h4>
421 <pre>protected transient boolean scanParameterAnnotations</pre>
424 <a name="scanFieldAnnotations">
427 <ul class="blockList">
428 <li class="blockList">
429 <h4>scanFieldAnnotations</h4>
430 <pre>protected transient boolean scanFieldAnnotations</pre>
433 <a name="ignoredPackages">
436 <ul class="blockList">
437 <li class="blockList">
438 <h4>ignoredPackages</h4>
439 <pre>protected transient <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] ignoredPackages</pre>
442 <a name="scanPackages">
445 <ul class="blockList">
446 <li class="blockList">
447 <h4>scanPackages</h4>
448 <pre>protected transient <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] scanPackages</pre>
451 <a name="ignoreBadURLs">
454 <ul class="blockListLast">
455 <li class="blockList">
456 <h4>ignoreBadURLs</h4>
457 <pre>protected transient boolean ignoreBadURLs</pre>
462 <!-- ========= CONSTRUCTOR DETAIL ======== -->
463 <ul class="blockList">
464 <li class="blockList"><a name="constructor_detail">
467 <h3>Constructor Detail</h3>
468 <a name="AnnotationDB()">
471 <ul class="blockListLast">
472 <li class="blockList">
473 <h4>AnnotationDB</h4>
474 <pre>public AnnotationDB()</pre>
479 <!-- ============ METHOD DETAIL ========== -->
480 <ul class="blockList">
481 <li class="blockList"><a name="method_detail">
484 <h3>Method Detail</h3>
485 <a name="getScanPackages()">
488 <ul class="blockList">
489 <li class="blockList">
490 <h4>getScanPackages</h4>
491 <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getScanPackages()</pre>
494 <a name="setScanPackages(java.lang.String[])">
497 <ul class="blockList">
498 <li class="blockList">
499 <h4>setScanPackages</h4>
500 <pre>public void setScanPackages(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] scanPackages)</pre>
501 <div class="block">Set explicit packages to scan.
502 Set to null to enable ignore list.</div>
503 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanPackages</code> - packages to scan or null</dd></dl>
506 <a name="getIgnoredPackages()">
509 <ul class="blockList">
510 <li class="blockList">
511 <h4>getIgnoredPackages</h4>
512 <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getIgnoredPackages()</pre>
515 <a name="setIgnoredPackages(java.lang.String[])">
518 <ul class="blockList">
519 <li class="blockList">
520 <h4>setIgnoredPackages</h4>
521 <pre>public void setIgnoredPackages(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] ignoredPackages)</pre>
522 <div class="block">Override/overwrite any ignored packages</div>
523 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoredPackages</code> - cannot be null</dd></dl>
526 <a name="addIgnoredPackages(java.lang.String...)">
529 <ul class="blockList">
530 <li class="blockList">
531 <h4>addIgnoredPackages</h4>
532 <pre>public void addIgnoredPackages(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... ignored)</pre>
535 <a name="crossReferenceMetaAnnotations()">
538 <ul class="blockList">
539 <li class="blockList">
540 <h4>crossReferenceMetaAnnotations</h4>
541 <pre>public void crossReferenceMetaAnnotations()
542 throws <a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation">AnnotationDB.CrossReferenceException</a></pre>
543 <div class="block">This method will cross reference annotations in the annotation index with any meta-annotations that they have
544 and create additional entries as needed. For example:
547 <dl><dt><span class="strong">Throws:</span></dt>
548 <dd><code><a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation">AnnotationDB.CrossReferenceException</a></code></dd></dl>
551 <a name="crossReferenceImplementedInterfaces()">
554 <ul class="blockList">
555 <li class="blockList">
556 <h4>crossReferenceImplementedInterfaces</h4>
557 <pre>public void crossReferenceImplementedInterfaces()
558 throws <a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation">AnnotationDB.CrossReferenceException</a></pre>
559 <div class="block">Sometimes you want to see if a particular class implements an interface with certain annotations
560 After you have loaded all your classpaths with the scanArchive() method, call this method to cross reference
561 a class's implemented interfaces. The cross references will be added to the annotationIndex and
562 classIndex indexes</div>
563 <dl><dt><span class="strong">Throws:</span></dt>
564 <dd><code><a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation">AnnotationDB.CrossReferenceException</a></code> - an Exception thrown if referenced interfaces haven't been scanned</dd></dl>
567 <a name="getAnnotationIndex()">
570 <ul class="blockList">
571 <li class="blockList">
572 <h4>getAnnotationIndex</h4>
573 <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> getAnnotationIndex()</pre>
574 <div class="block">returns a map keyed by the fully qualified string name of a annotation class. The Set returne is
575 a list of classes that use that annotation somehow.</div>
578 <a name="getClassIndex()">
581 <ul class="blockList">
582 <li class="blockList">
583 <h4>getClassIndex</h4>
584 <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> getClassIndex()</pre>
585 <div class="block">returns a map keyed by the list of classes scanned. The value set returned is a list of annotations
586 used by that class.</div>
589 <a name="setScanClassAnnotations(boolean)">
592 <ul class="blockList">
593 <li class="blockList">
594 <h4>setScanClassAnnotations</h4>
595 <pre>public void setScanClassAnnotations(boolean scanClassAnnotations)</pre>
596 <div class="block">Whether or not you want AnnotationDB to scan for class level annotations</div>
597 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanClassAnnotations</code> - </dd></dl>
600 <a name="setScanMethodAnnotations(boolean)">
603 <ul class="blockList">
604 <li class="blockList">
605 <h4>setScanMethodAnnotations</h4>
606 <pre>public void setScanMethodAnnotations(boolean scanMethodAnnotations)</pre>
607 <div class="block">Wheter or not you want AnnotationDB to scan for method level annotations</div>
608 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanMethodAnnotations</code> - </dd></dl>
611 <a name="setScanParameterAnnotations(boolean)">
614 <ul class="blockList">
615 <li class="blockList">
616 <h4>setScanParameterAnnotations</h4>
617 <pre>public void setScanParameterAnnotations(boolean scanParameterAnnotations)</pre>
618 <div class="block">Whether or not you want AnnotationDB to scan for parameter level annotations</div>
619 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanParameterAnnotations</code> - </dd></dl>
622 <a name="setScanFieldAnnotations(boolean)">
625 <ul class="blockList">
626 <li class="blockList">
627 <h4>setScanFieldAnnotations</h4>
628 <pre>public void setScanFieldAnnotations(boolean scanFieldAnnotations)</pre>
629 <div class="block">Whether or not you want AnnotationDB to scan for parameter level annotations</div>
630 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanFieldAnnotations</code> - </dd></dl>
633 <a name="setIgnoreBadURLs(boolean)">
636 <ul class="blockList">
637 <li class="blockList">
638 <h4>setIgnoreBadURLs</h4>
639 <pre>public void setIgnoreBadURLs(boolean ignoreBadURLs)</pre>
640 <div class="block">Whether or not you want AnnotationDB to ignore bad URLs passed to scanArchives.
641 Default is to throw an IOException.</div>
642 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreBadURLs</code> - </dd></dl>
645 <a name="scanArchives(java.net.URL...)">
648 <ul class="blockList">
649 <li class="blockList">
650 <h4>scanArchives</h4>
651 <pre>public void scanArchives(<a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>... urls)
652 throws <a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
653 <div class="block">Scan a url that represents an "archive" this is a classpath directory or jar file</div>
654 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>urls</code> - variable list of URLs to scan as archives</dd>
655 <dt><span class="strong">Throws:</span></dt>
656 <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
659 <a name="scanClass(java.io.InputStream)">
662 <ul class="blockList">
663 <li class="blockList">
665 <pre>public void scanClass(<a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> bits)
666 throws <a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
667 <div class="block">Parse a .class file for annotations</div>
668 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bits</code> - input stream pointing to .class file bits</dd>
669 <dt><span class="strong">Throws:</span></dt>
670 <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
673 <a name="scanClass(javassist.bytecode.ClassFile)">
676 <ul class="blockList">
677 <li class="blockList">
679 <pre>protected void scanClass(javassist.bytecode.ClassFile cf)</pre>
682 <a name="scanMethods(javassist.bytecode.ClassFile)">
685 <ul class="blockList">
686 <li class="blockList">
688 <pre>protected void scanMethods(javassist.bytecode.ClassFile cf)</pre>
689 <div class="block">Scanns both the method and its parameters for annotations.</div>
690 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cf</code> - </dd></dl>
693 <a name="scanFields(javassist.bytecode.ClassFile)">
696 <ul class="blockList">
697 <li class="blockList">
699 <pre>protected void scanFields(javassist.bytecode.ClassFile cf)</pre>
702 <a name="populate(javassist.bytecode.annotation.Annotation[], java.lang.String)">
705 <ul class="blockList">
706 <li class="blockList">
708 <pre>protected void populate(javassist.bytecode.annotation.Annotation[] annotations,
709 <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</pre>
712 <a name="outputAnnotationIndex(java.io.PrintWriter)">
715 <ul class="blockListLast">
716 <li class="blockList">
717 <h4>outputAnnotationIndex</h4>
718 <pre>public void outputAnnotationIndex(<a href="http://java.sun.com/javase/6/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> writer)</pre>
719 <div class="block">Prints out annotationIndex</div>
720 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - </dd></dl>
729 <!-- ========= END OF CLASS DATA ========= -->
730 <!-- ======= START OF BOTTOM NAVBAR ====== -->
731 <div class="bottomNav"><a name="navbar_bottom">
733 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
736 <ul class="navList" title="Navigation">
737 <li><a href="../../overview-summary.html">Overview</a></li>
738 <li><a href="package-summary.html">Package</a></li>
739 <li class="navBarCell1Rev">Class</li>
740 <li><a href="class-use/AnnotationDB.html">Use</a></li>
741 <li><a href="package-tree.html">Tree</a></li>
742 <li><a href="../../deprecated-list.html">Deprecated</a></li>
743 <li><a href="../../index-all.html">Index</a></li>
744 <li><a href="../../help-doc.html">Help</a></li>
750 <li><a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation"><span class="strong">Next Class</span></a></li>
753 <li><a href="../../index.html?org/scannotation/AnnotationDB.html" target="_top">Frames</a></li>
754 <li><a href="AnnotationDB.html" target="_top">No Frames</a></li>
756 <ul class="navList" id="allclasses_navbar_bottom">
757 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
760 <script type="text/javascript"><!--
761 allClassesLink = document.getElementById("allclasses_navbar_bottom");
763 allClassesLink.style.display = "block";
766 allClassesLink.style.display = "none";
772 <ul class="subNavList">
773 <li>Summary: </li>
774 <li><a href="#nested_class_summary">Nested</a> | </li>
775 <li><a href="#field_summary">Field</a> | </li>
776 <li><a href="#constructor_summary">Constr</a> | </li>
777 <li><a href="#method_summary">Method</a></li>
779 <ul class="subNavList">
780 <li>Detail: </li>
781 <li><a href="#field_detail">Field</a> | </li>
782 <li><a href="#constructor_detail">Constr</a> | </li>
783 <li><a href="#method_detail">Method</a></li>
786 <a name="skip-navbar_bottom">
789 <!-- ======== END OF BOTTOM NAVBAR ======= -->
790 <p class="legalCopy"><small>Copyright © 2015. All Rights Reserved.</small></p>