Index (scannotation 1.0.4 API)

A C D F G I J M N O P R S W - - -

A

accepts(String) - Method in interface org.scannotation.archiveiterator.Filter
addIgnoredPackages(String...) - Method in class org.scannotation.AnnotationDB
AnnotationDB - Class in org.scannotation: -
The class allows you to scan an arbitrary set of "archives" for .class files.
-
AnnotationDB() - Constructor for class org.scannotation.AnnotationDB
AnnotationDB.CrossReferenceException - Exception in org.scannotation
AnnotationDB.CrossReferenceException(Set<String>) - Constructor for exception org.scannotation.AnnotationDB.CrossReferenceException
annotationIndex - Variable in class org.scannotation.AnnotationDB
available() - Method in class org.scannotation.archiveiterator.InputStreamWrapper

- - - -

C

classIndex - Variable in class org.scannotation.AnnotationDB
ClasspathUrlFinder - Class in org.scannotation: -
Various functions to locate URLs to scan
-
ClasspathUrlFinder() - Constructor for class org.scannotation.ClasspathUrlFinder
close() - Method in class org.scannotation.archiveiterator.FileIterator
close() - Method in class org.scannotation.archiveiterator.InputStreamWrapper
close() - Method in class org.scannotation.archiveiterator.JarIterator
close() - Method in interface org.scannotation.archiveiterator.StreamIterator: -
Cleanup any open resources of the iterator
-
create(URL, Filter) - Method in interface org.scannotation.archiveiterator.DirectoryIteratorFactory
create(List, File, Filter) - Static method in class org.scannotation.archiveiterator.FileIterator
create(List, File, Filter, String) - Static method in class org.scannotation.archiveiterator.FileIterator
create(URL, Filter) - Method in class org.scannotation.archiveiterator.FileProtocolIteratorFactory
create(URL, Filter) - Static method in class org.scannotation.archiveiterator.IteratorFactory
crossReferenceImplementedInterfaces() - Method in class org.scannotation.AnnotationDB: -
Sometimes you want to see if a particular class implements an interface with certain annotations - After you have loaded all your classpaths with the scanArchive() method, call this method to cross reference - a class's implemented interfaces.
-
crossReferenceMetaAnnotations() - Method in class org.scannotation.AnnotationDB: -
This method will cross reference annotations in the annotation index with any meta-annotations that they have - and create additional entries as needed.
-

- - - -

D

DirectoryIteratorFactory - Interface in org.scannotation.archiveiterator

- - - -

F

FileIterator - Class in org.scannotation.archiveiterator
FileIterator(File, Filter) - Constructor for class org.scannotation.archiveiterator.FileIterator
FileProtocolIteratorFactory - Class in org.scannotation.archiveiterator
FileProtocolIteratorFactory() - Constructor for class org.scannotation.archiveiterator.FileProtocolIteratorFactory
Filter - Interface in org.scannotation.archiveiterator
findClassBase(Class) - Static method in class org.scannotation.ClasspathUrlFinder: -
Find the classpath for the particular class
-
findClassPaths() - Static method in class org.scannotation.ClasspathUrlFinder: -
Uses the java.class.path system property to obtain a list of URLs that represent the CLASSPATH
-
findClassPaths(String...) - Static method in class org.scannotation.ClasspathUrlFinder: -
Uses the java.class.path system property to obtain a list of URLs that represent the CLASSPATH -
- paths is used as a filter to only include paths that have the specific relative file within it
-
findResourceBase(String) - Static method in class org.scannotation.ClasspathUrlFinder: -
Find the classpath URL for a specific classpath resource.
-
findResourceBase(String, ClassLoader) - Static method in class org.scannotation.ClasspathUrlFinder: -
Find the classpath URL for a specific classpath resource.
-
findResourceBases(String, ClassLoader) - Static method in class org.scannotation.ClasspathUrlFinder: -
Find the classpath URLs for a specific classpath resource.
-
findResourceBases(String) - Static method in class org.scannotation.ClasspathUrlFinder: -
Find the classpath URLs for a specific classpath resource.
-
findWebInfClassesPath(ServletContextEvent) - Static method in class org.scannotation.WarUrlFinder
findWebInfClassesPath(ServletContext) - Static method in class org.scannotation.WarUrlFinder: -
Find the URL pointing to "/WEB-INF/classes" This method may not work in conjunction with IteratorFactory - if your servlet container does not extract the /WEB-INF/classes into a real file-based directory
-
findWebInfLibClasspaths(ServletContextEvent) - Static method in class org.scannotation.WarUrlFinder
findWebInfLibClasspaths(ServletContext) - Static method in class org.scannotation.WarUrlFinder

- - - -

G

getAnnotationIndex() - Method in class org.scannotation.AnnotationDB: -
returns a map keyed by the fully qualified string name of a annotation class.
-
getClassIndex() - Method in class org.scannotation.AnnotationDB: -
returns a map keyed by the list of classes scanned.
-
getIgnoredPackages() - Method in class org.scannotation.AnnotationDB
getScanPackages() - Method in class org.scannotation.AnnotationDB
getUnresolved() - Method in exception org.scannotation.AnnotationDB.CrossReferenceException

- - - -

I

ignoreBadURLs - Variable in class org.scannotation.AnnotationDB
ignoredPackages - Variable in class org.scannotation.AnnotationDB
implementsIndex - Variable in class org.scannotation.AnnotationDB
InputStreamWrapper - Class in org.scannotation.archiveiterator: -
Delegate to everything but close().
-
InputStreamWrapper(InputStream) - Constructor for class org.scannotation.archiveiterator.InputStreamWrapper
IteratorFactory - Class in org.scannotation.archiveiterator
IteratorFactory() - Constructor for class org.scannotation.archiveiterator.IteratorFactory

- - - -

J

JarIterator - Class in org.scannotation.archiveiterator
JarIterator(File, Filter) - Constructor for class org.scannotation.archiveiterator.JarIterator
JarIterator(InputStream, Filter) - Constructor for class org.scannotation.archiveiterator.JarIterator

- - - -

M

mark(int) - Method in class org.scannotation.archiveiterator.InputStreamWrapper
markSupported() - Method in class org.scannotation.archiveiterator.InputStreamWrapper

- - - -

N

next() - Method in class org.scannotation.archiveiterator.FileIterator
next() - Method in class org.scannotation.archiveiterator.JarIterator
next() - Method in interface org.scannotation.archiveiterator.StreamIterator: -
User is resposible for closing the InputStream returned
-

- - - -

O

org.scannotation - package org.scannotation
org.scannotation.archiveiterator - package org.scannotation.archiveiterator
outputAnnotationIndex(PrintWriter) - Method in class org.scannotation.AnnotationDB: -
Prints out annotationIndex
-

- - - -

P

populate(Annotation[], String) - Method in class org.scannotation.AnnotationDB

- - - -

R

read() - Method in class org.scannotation.archiveiterator.InputStreamWrapper
read(byte[]) - Method in class org.scannotation.archiveiterator.InputStreamWrapper
read(byte[], int, int) - Method in class org.scannotation.archiveiterator.InputStreamWrapper
reset() - Method in class org.scannotation.archiveiterator.InputStreamWrapper

- - - -

S

scanArchives(URL...) - Method in class org.scannotation.AnnotationDB: -
Scan a url that represents an "archive" this is a classpath directory or jar file
-
scanClass(InputStream) - Method in class org.scannotation.AnnotationDB: -
Parse a .class file for annotations
-
scanClass(ClassFile) - Method in class org.scannotation.AnnotationDB
scanClassAnnotations - Variable in class org.scannotation.AnnotationDB
scanFieldAnnotations - Variable in class org.scannotation.AnnotationDB
scanFields(ClassFile) - Method in class org.scannotation.AnnotationDB
scanMethodAnnotations - Variable in class org.scannotation.AnnotationDB
scanMethods(ClassFile) - Method in class org.scannotation.AnnotationDB: -
Scanns both the method and its parameters for annotations.
-
scanPackages - Variable in class org.scannotation.AnnotationDB
scanParameterAnnotations - Variable in class org.scannotation.AnnotationDB
setIgnoreBadURLs(boolean) - Method in class org.scannotation.AnnotationDB: -
Whether or not you want AnnotationDB to ignore bad URLs passed to scanArchives.
-
setIgnoredPackages(String[]) - Method in class org.scannotation.AnnotationDB: -
Override/overwrite any ignored packages
-
setScanClassAnnotations(boolean) - Method in class org.scannotation.AnnotationDB: -
Whether or not you want AnnotationDB to scan for class level annotations
-
setScanFieldAnnotations(boolean) - Method in class org.scannotation.AnnotationDB: -
Whether or not you want AnnotationDB to scan for parameter level annotations
-
setScanMethodAnnotations(boolean) - Method in class org.scannotation.AnnotationDB: -
Wheter or not you want AnnotationDB to scan for method level annotations
-
setScanPackages(String[]) - Method in class org.scannotation.AnnotationDB: -
Set explicit packages to scan.
-
setScanParameterAnnotations(boolean) - Method in class org.scannotation.AnnotationDB: -
Whether or not you want AnnotationDB to scan for parameter level annotations
-
skip(long) - Method in class org.scannotation.archiveiterator.InputStreamWrapper
StreamIterator - Interface in org.scannotation.archiveiterator: -
Simpler iterator than java.util.iterator.
-

- - - -

W

WarUrlFinder - Class in org.scannotation
WarUrlFinder() - Constructor for class org.scannotation.WarUrlFinder

-A C D F G I J M N O P R S W