Package org.eclipse.jetty.ee10.annotations

Class AnnotationParser

java.lang.Object

org.eclipse.jetty.ee10.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	Description
static class	AnnotationParser.AbstractHandler	Convenience base class to provide no-ops for all Handler methods.
static class	AnnotationParser.ClassInfo	Immutable information gathered by parsing class header.
static class	AnnotationParser.FieldInfo	Immutable information gathered by parsing a field on a class.
static interface	AnnotationParser.Handler	Signature for all handlers that respond to parsing class files.
static class	AnnotationParser.MethodInfo	Immutable information gathered by parsing a method on a class.
static class	AnnotationParser.MyClassVisitor	ASM visitor for a class.
static class	AnnotationParser.MyFieldVisitor	An ASM visitor for parsing Fields.
static class	AnnotationParser.MyMethodVisitor	ASM Visitor for parsing a method.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,URI>	_parsedClassNames	Map of classnames scanned and the first location from which scan occurred

Constructor Summary

Constructors

Constructor	Description
AnnotationParser()
AnnotationParser(int asmVersion)

Method Summary

Modifier and Type	Method	Description
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, Resource r)	Parse a resource
protected void	parseClass(Set<? extends AnnotationParser.Handler> handlers, Resource containingResource, Path classFile)	Use ASM on a class
protected void	parseDir(Set<? extends AnnotationParser.Handler> handlers, Resource dirResource)	Parse all classes in a directory
protected void	parseJar(Set<? extends AnnotationParser.Handler> handlers, Resource jarResource)	Parse a resource that is a jar file.

Methods inherited from class java.lang.Object

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

Field Details

_parsedClassNames

protected Map<String,URI> _parsedClassNames

Map of classnames scanned and the first location from which scan occurred

Constructor Details

AnnotationParser

public AnnotationParser()

AnnotationParser

public AnnotationParser(int asmVersion)

Parameters:

asmVersion - The target asm version or 0 for the internal version.

Method Details

normalize

public static String normalize(String name)

Convert internal name to simple name

Parameters:

name - the internal name

Returns:

the simple name

normalize

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

Convert internal names to simple names.

Parameters:

list - the list of internal names

Returns:

the array of simple names

parse

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

Parse a resource

Parameters:

handlers - the handlers to look for classes in

r - the resource to parse

Throws:

Exception - if unable to parse

parseDir

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

Parse all classes in a directory

Parameters:

handlers - the set of handlers to look for classes in

dirResource - the resource representing the baseResource being scanned (jar, dir, etc)

Throws:

Exception - if unable to parse

parseJar

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

Parse a resource that is a jar file.

Parameters:

handlers - the handlers to look for classes in

jarResource - the jar resource to parse

Throws:

Exception - if unable to parse

parseClass

protected void parseClass(Set<? extends AnnotationParser.Handler> handlers,
 Resource containingResource,
 Path classFile)
                   throws IOException

Use ASM on a class

Parameters:

handlers - the handlers to look for classes in

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

classFile - the class file to parse

Throws:

IOException - if unable to parse