org.eclipse.jetty.annotations

Class AnnotationParser

java.lang.Object

org.eclipse.jetty.annotations.AnnotationParser

Direct Known Subclasses:

AnnotationParser

public class AnnotationParser
extends Object

AnnotationParser 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. Handlers are not called back in any particular order and are assumed to be order-independent. 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. 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationParser.AbstractHandler AbstractHandler Convenience base class to provide no-ops for all Handler methods.
class	AnnotationParser.ClassInfo ClassInfo Immutable information gathered by parsing class header.
class	AnnotationParser.FieldInfo FieldInfo Immutable information gathered by parsing a field on a class.
static interface	AnnotationParser.Handler Handler Signature for all handlers that respond to parsing class files.
class	AnnotationParser.MethodInfo MethodInfo Immutable information gathered by parsing a method on a class.
class	AnnotationParser.MyClassVisitor MyClassVisitor ASM visitor for a class.
class	AnnotationParser.MyFieldVisitor MyFieldVisitor An ASM visitor for parsing Fields.
class	AnnotationParser.MyMethodVisitor MyMethodVisitor ASM Visitor for parsing a method.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	_parsedClassNames
protected static int	ASM_OPCODE_VERSION

Constructor Summary

Constructors

Constructor and Description
AnnotationParser()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isParsed(String className) True if the class has already been processed, false otherwise
static String	normalize(String name) Convert internal name to simple name
static String[]	normalize(String[] list) Convert internal names to simple names.
void	parse(Set<? extends AnnotationParser.Handler> handlers, Class<?> clazz, ClassNameResolver resolver, boolean visitSuperClasses) Parse the given class, optionally walking its inheritance hierarchy
void	parse(Set<? extends AnnotationParser.Handler> handlers, ClassLoader loader, boolean visitParents, boolean nullInclusive, ClassNameResolver resolver) Parse classes in the supplied classloader.
void	parse(Set<? extends AnnotationParser.Handler> handlers, List<String> classNames, ClassNameResolver resolver) Parse the given classes
void	parse(Set<? extends AnnotationParser.Handler> handlers, Resource r, ClassNameResolver resolver) Parse a resource
void	parse(Set<? extends AnnotationParser.Handler> handlers, String[] classNames, ClassNameResolver resolver) Parse the given classes
void	parse(Set<? extends AnnotationParser.Handler> handlers, String className, ClassNameResolver resolver) Parse a given class
void	parse(Set<? extends AnnotationParser.Handler> handlers, URI[] uris, ClassNameResolver resolver) Parse classes in the supplied uris.
void	parse(Set<? extends AnnotationParser.Handler> handlers, URI uri, ClassNameResolver resolver) Parse a particular uri
protected void	parseDir(Set<? extends AnnotationParser.Handler> handlers, Resource dir, ClassNameResolver resolver) Parse all classes in a directory
protected void	parseJar(Set<? extends AnnotationParser.Handler> handlers, Resource jarResource, ClassNameResolver resolver) Parse a resource that is a jar file.
protected void	parseJarEntry(Set<? extends AnnotationParser.Handler> handlers, Resource jar, JarEntry entry, ClassNameResolver resolver) Parse a single entry in a jar file
protected void	scanClass(Set<? extends AnnotationParser.Handler> handlers, Resource containingResource, InputStream is) Use ASM on a class

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_parsedClassNames

protected Set<String> _parsedClassNames

ASM_OPCODE_VERSION

protected static int ASM_OPCODE_VERSION

Constructor Detail

AnnotationParser

public AnnotationParser()

Method Detail

normalize

public static String normalize(String name)

Convert internal name to simple name

Parameters:

name -

Returns:

normalize

public static String[] normalize(String[] list)

Convert internal names to simple names.

Parameters:

list -

Returns:

isParsed

public boolean isParsed(String className)

True if the class has already been processed, false otherwise

Parameters:

className -

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         String className,
         ClassNameResolver resolver)
           throws Exception

Parse a given class

Parameters:

className -

resolver -

Throws:

Exception

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         Class<?> clazz,
         ClassNameResolver resolver,
         boolean visitSuperClasses)
           throws Exception

Parse the given class, optionally walking its inheritance hierarchy

Parameters:

clazz -

resolver -

visitSuperClasses -

Throws:

Exception

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         String[] classNames,
         ClassNameResolver resolver)
           throws Exception

Parse the given classes

Parameters:

classNames -

resolver -

Throws:

Exception

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         List<String> classNames,
         ClassNameResolver resolver)
           throws Exception

Parse the given classes

Parameters:

classNames -

resolver -

Throws:

Exception

parseDir

protected void parseDir(Set<? extends AnnotationParser.Handler> handlers,
            Resource dir,
            ClassNameResolver resolver)
                 throws Exception

Parse all classes in a directory

Parameters:

dir -

resolver -

Throws:

Exception

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         ClassLoader loader,
         boolean visitParents,
         boolean nullInclusive,
         ClassNameResolver resolver)
           throws Exception

Parse classes in the supplied classloader. Only class files in jar files will be scanned.

Parameters:

loader -

visitParents -

nullInclusive -

resolver -

Throws:

Exception

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         URI[] uris,
         ClassNameResolver resolver)
           throws Exception

Parse classes in the supplied uris.

Parameters:

uris -

resolver -

Throws:

Exception

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         URI uri,
         ClassNameResolver resolver)
           throws Exception

Parse a particular uri

Parameters:

uri -

resolver -

Throws:

Exception

parse

public void parse(Set<? extends AnnotationParser.Handler> handlers,
         Resource r,
         ClassNameResolver resolver)
           throws Exception

Parse a resource

Parameters:

r -

resolver -

Throws:

Exception

parseJar

protected void parseJar(Set<? extends AnnotationParser.Handler> handlers,
            Resource jarResource,
            ClassNameResolver resolver)
                 throws Exception

Parse a resource that is a jar file.

Parameters:

jarResource -

resolver -

Throws:

Exception

parseJarEntry

protected void parseJarEntry(Set<? extends AnnotationParser.Handler> handlers,
                 Resource jar,
                 JarEntry entry,
                 ClassNameResolver resolver)
                      throws Exception

Parse a single entry in a jar file

Parameters:

jar -

entry -

resolver -

Throws:

Exception

scanClass

protected void scanClass(Set<? extends AnnotationParser.Handler> handlers,
             Resource containingResource,
             InputStream is)
                  throws IOException

Use ASM on a class

Parameters:

containingResource - the dir or jar that the class is contained within, can be null if not known

is -

Throws:

IOException