Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	AnnotationFinder.AnnotatedStructure AnnotatedStructure Annotations on an object such as a class, field or method.
public class	AnnotationFinder.MyClassVisitor MyClassVisitor ASM visitor for a class.
public static class	AnnotationFinder.ParsedClass ParsedClass A class that contains annotations.
public static class	AnnotationFinder.ParsedField ParsedField A class field that can contain annotations.
public static class	AnnotationFinder.ParsedMethod ParsedMethod A class method that can contain annotations.

Modifier and Type	Field and Description
private Map<String, AnnotationFinder.ParsedClass>	parsedClasses

Constructor Summary

Access	Constructor and Description
public	AnnotationFinder()

Method Summary

Modifier and Type	Method and Description
public static Class<T>	convertType(Type t)
public static Class<T>[]	convertTypes(Type[] types)
protected boolean	excludeClass(String name) Exclude class by name Instances of `AnnotationFinder` can implement this method to exclude classes by name.
public void	find(String className, ClassNameResolver resolver)
public void	find(String[] classNames, ClassNameResolver resolver)
public void	find(List<String> classNames, ClassNameResolver resolver)
public void	find(Resource dir, ClassNameResolver resolver)
public void	find(ClassLoader loader, boolean visitParents, String jarNamePattern, boolean nullInclusive, final ClassNameResolver resolver)
public List<Class<?>>	getClassesForAnnotation(Class<?> annotationClass)
public List<Field>	getFieldsForAnnotation(Class<?> annotation)
public List<Method>	getMethodsForAnnotation(Class<?> annotationClass)
public static String	normalize(String name)
private void	scanClass(InputStream is)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

parsedClasses	back to summary
private Map<String, AnnotationFinder.ParsedClass> parsedClasses

Constructor Detail

AnnotationFinder	back to summary
public AnnotationFinder()

Method Detail

convertType	back to summary
public static Class<T> convertType(Type t) throws Exception

convertTypes	back to summary
public static Class<T>[] convertTypes(Type[] types) throws Exception

excludeClass	back to summary
protected boolean excludeClass(String name) Exclude class by name Instances of `AnnotationFinder` can implement this method to exclude classes by name.

find	back to summary
public void find(String className, ClassNameResolver resolver) throws Exception

find	back to summary
public void find(String[] classNames, ClassNameResolver resolver) throws Exception

find	back to summary
public void find(List<String> classNames, ClassNameResolver resolver) throws Exception

find	back to summary
public void find(Resource dir, ClassNameResolver resolver) throws Exception

find	back to summary
public void find(ClassLoader loader, boolean visitParents, String jarNamePattern, boolean nullInclusive, final ClassNameResolver resolver) throws Exception

getClassesForAnnotation	back to summary
public List<Class<?>> getClassesForAnnotation(Class<?> annotationClass) throws Exception

getFieldsForAnnotation	back to summary
public List<Field> getFieldsForAnnotation(Class<?> annotation) throws Exception

getMethodsForAnnotation	back to summary
public List<Method> getMethodsForAnnotation(Class<?> annotationClass) throws Exception

normalize	back to summary
public static String normalize(String name)

scanClass	back to summary
private void scanClass(InputStream is) throws IOException

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

org.mortbay.jetty.annotations back to summary

public Class AnnotationFinder.AnnotatedStructure

Class Inheritance

extends EmptyVisitor

java.lang.Object
org.objectweb.asm.commons.EmptyVisitor
org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure

Known Direct Subclasses

org.mortbay.jetty.annotations.AnnotationFinder.ParsedClass, org.mortbay.jetty.annotations.AnnotationFinder.ParsedMethod, org.mortbay.jetty.annotations.AnnotationFinder.ParsedField

AnnotatedStructure Annotations on an object such as a class, field or method.

Field Summary

Modifier and Type	Field and Description
pack-priv Map<String, Map<String, Object>>	annotations

Constructor Summary

Access	Constructor and Description
public	AnnotatedStructure()

Method Summary

Modifier and Type	Method and Description
public AnnotationVisitor	addAnnotation(final String name)
public Map<String, Map<String, Object>>	getAnnotations()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

annotations	back to summary
pack-priv Map<String, Map<String, Object>> annotations

Constructor Detail

AnnotatedStructure	back to summary
public AnnotatedStructure()

Method Detail

addAnnotation	back to summary
public AnnotationVisitor addAnnotation(final String name)

getAnnotations	back to summary
public Map<String, Map<String, Object>> getAnnotations()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

org.mortbay.jetty.annotations back to summary

public Class AnnotationFinder.MyClassVisitor

Class Inheritance

extends EmptyVisitor

java.lang.Object
org.objectweb.asm.commons.EmptyVisitor
org.mortbay.jetty.annotations.AnnotationFinder.MyClassVisitor

MyClassVisitor ASM visitor for a class.

Field Summary

Modifier and Type	Field and Description
pack-priv AnnotationFinder.ParsedClass	pclass

Constructor Summary

Access	Constructor and Description
public	MyClassVisitor()

Method Summary

Modifier and Type	Method and Description
public void	visit(int the class version. version, int the class's access flags (see `Opcodes`). This parameter also indicates if the class is deprecated. access, String the internal name of the class (see `getInternalName`). name, String the signature of this class. May be `null` if the class is not a generic one, and does not extend or implement generic classes or interfaces. signature, String the internal of name of the super class (see `getInternalName`). For interfaces, the super class is `Object`. May be `null`, but only for the `Object` class. superName, String[] the internal names of the class's interfaces (see `getInternalName`). May be `null`. interfaces) Overrides org.objectweb.asm.commons.EmptyVisitor.visit. Implements org.objectweb.asm.ClassVisitor.visit. Visits the header of the class.
public AnnotationVisitor	visitAnnotation(String the class descriptor of the annotation class. desc, boolean `true` if the annotation is visible at runtime. visible) Overrides org.objectweb.asm.commons.EmptyVisitor.visitAnnotation. Implements org.objectweb.asm.ClassVisitor.visitAnnotation, org.objectweb.asm.FieldVisitor.visitAnnotation, org.objectweb.asm.MethodVisitor.visitAnnotation. Visits an annotation of the class.
public FieldVisitor	visitField(int the field's access flags (see `Opcodes`). This parameter also indicates if the field is synthetic and/or deprecated. access, String the field's name. name, String the field's descriptor (see `Type`). desc, String the field's signature. May be `null` if the field's type does not use generic types. signature, Object the field's initial value. This parameter, which may be `null` if the field does not have an initial value, must be an `Integer`, a `Float`, a `Long`, a `Double` or a `String` (for `int`, `float`, `long` or `String` fields respectively). This parameter is only used for static fields. Its value is ignored for non static fields, which must be initialized through bytecode instructions in constructors or methods. value) Overrides org.objectweb.asm.commons.EmptyVisitor.visitField. Implements org.objectweb.asm.ClassVisitor.visitField. Visits a field of the class.
public MethodVisitor	visitMethod(int the method's access flags (see `Opcodes`). This parameter also indicates if the method is synthetic and/or deprecated. access, String the method's name. name, String the method's descriptor (see `Type`). desc, String the method's signature. May be `null` if the method parameters, return type and exceptions do not use generic types. signature, String[] the internal names of the method's exception classes (see `getInternalName`). May be `null`. exceptions) Overrides org.objectweb.asm.commons.EmptyVisitor.visitMethod. Implements org.objectweb.asm.ClassVisitor.visitMethod. Visits a method of the class.

Field Detail

pclass	back to summary
pack-priv AnnotationFinder.ParsedClass pclass

Constructor Detail

MyClassVisitor	back to summary
public MyClassVisitor()

Method Detail

visit back to summary

visit	back to summary
public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) Overrides org.objectweb.asm.commons.EmptyVisitor.visit. Implements org.objectweb.asm.ClassVisitor.visit. Doc from org.objectweb.asm.ClassVisitor.visit. Visits the header of the class. Parameters version:int the class version. access:int the class's access flags (see `Opcodes`). This parameter also indicates if the class is deprecated. name:String the internal name of the class (see `getInternalName`). signature:String the signature of this class. May be `null` if the class is not a generic one, and does not extend or implement generic classes or interfaces. superName:String the internal of name of the super class (see `getInternalName`). For interfaces, the super class is `Object`. May be `null`, but only for the `Object` class. interfaces:String[] the internal names of the class's interfaces (see `getInternalName`). May be `null`.

public void visit(int version, int access, String name, String signature, String superName, String[] interfaces)

Overrides org.objectweb.asm.commons.EmptyVisitor.visit.

Implements org.objectweb.asm.ClassVisitor.visit.

Doc from org.objectweb.asm.ClassVisitor.visit.

Visits the header of the class.

Parameters

version:int: the class version.
access:int: the class's access flags (see Opcodes). This parameter also indicates if the class is deprecated.
name:String: the internal name of the class (see getInternalName).
signature:String: the signature of this class. May be null if the class is not a generic one, and does not extend or implement generic classes or interfaces.
superName:String: the internal of name of the super class (see getInternalName). For interfaces, the super class is Object. May be null, but only for the Object class.
interfaces:String[]: the internal names of the class's interfaces (see getInternalName). May be null.

visitAnnotation back to summary

visitAnnotation	back to summary
public AnnotationVisitor visitAnnotation(String desc, boolean visible) Overrides org.objectweb.asm.commons.EmptyVisitor.visitAnnotation. Implements org.objectweb.asm.ClassVisitor.visitAnnotation, org.objectweb.asm.FieldVisitor.visitAnnotation, org.objectweb.asm.MethodVisitor.visitAnnotation. Doc from org.objectweb.asm.ClassVisitor.visitAnnotation. Visits an annotation of the class. Parameters desc:String the class descriptor of the annotation class. visible:boolean `true` if the annotation is visible at runtime. Returns:AnnotationVisitor a visitor to visit the annotation values, or `null` if this visitor is not interested in visiting this annotation.

public AnnotationVisitor visitAnnotation(String desc, boolean visible)

Overrides org.objectweb.asm.commons.EmptyVisitor.visitAnnotation.

Implements org.objectweb.asm.ClassVisitor.visitAnnotation, org.objectweb.asm.FieldVisitor.visitAnnotation, org.objectweb.asm.MethodVisitor.visitAnnotation.

Doc from org.objectweb.asm.ClassVisitor.visitAnnotation.

Visits an annotation of the class.

Parameters

desc:String: the class descriptor of the annotation class.
visible:boolean: true if the annotation is visible at runtime.

Returns:AnnotationVisitor

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

visitField back to summary

visitField	back to summary
public FieldVisitor visitField(int access, String name, String desc, String signature, Object value) Overrides org.objectweb.asm.commons.EmptyVisitor.visitField. Implements org.objectweb.asm.ClassVisitor.visitField. Doc from org.objectweb.asm.ClassVisitor.visitField. Visits a field of the class. Parameters access:int the field's access flags (see `Opcodes`). This parameter also indicates if the field is synthetic and/or deprecated. name:String the field's name. desc:String the field's descriptor (see `Type`). signature:String the field's signature. May be `null` if the field's type does not use generic types. value:Object the field's initial value. This parameter, which may be `null` if the field does not have an initial value, must be an `Integer`, a `Float`, a `Long`, a `Double` or a `String` (for `int`, `float`, `long` or `String` fields respectively). This parameter is only used for static fields. Its value is ignored for non static fields, which must be initialized through bytecode instructions in constructors or methods. Returns:FieldVisitor a visitor to visit field annotations and attributes, or `null` if this class visitor is not interested in visiting these annotations and attributes.

public FieldVisitor visitField(int access, String name, String desc, String signature, Object value)

Overrides org.objectweb.asm.commons.EmptyVisitor.visitField.

Implements org.objectweb.asm.ClassVisitor.visitField.

Doc from org.objectweb.asm.ClassVisitor.visitField.

Visits a field of the class.

Parameters

access:int: the field's access flags (see Opcodes). This parameter also indicates if the field is synthetic and/or deprecated.
name:String: the field's name.
desc:String: the field's descriptor (see Type).
signature:String: the field's signature. May be null if the field's type does not use generic types.
value:Object: the field's initial value. This parameter, which may be null if the field does not have an initial value, must be an Integer, a Float, a Long, a Double or a String (for int, float, long or String fields respectively). This parameter is only used for static fields. Its value is ignored for non static fields, which must be initialized through bytecode instructions in constructors or methods.

Returns:FieldVisitor

a visitor to visit field annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

visitMethod back to summary

visitMethod	back to summary
public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) Overrides org.objectweb.asm.commons.EmptyVisitor.visitMethod. Implements org.objectweb.asm.ClassVisitor.visitMethod. Doc from org.objectweb.asm.ClassVisitor.visitMethod. Visits a method of the class. This method must return a new `MethodVisitor` instance (or `null`) each time it is called, i.e., it should not return a previously returned visitor. Parameters access:int the method's access flags (see `Opcodes`). This parameter also indicates if the method is synthetic and/or deprecated. name:String the method's name. desc:String the method's descriptor (see `Type`). signature:String the method's signature. May be `null` if the method parameters, return type and exceptions do not use generic types. exceptions:String[] the internal names of the method's exception classes (see `getInternalName`). May be `null`. Returns:MethodVisitor an object to visit the byte code of the method, or `null` if this class visitor is not interested in visiting the code of this method.

public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions)

Overrides org.objectweb.asm.commons.EmptyVisitor.visitMethod.

Implements org.objectweb.asm.ClassVisitor.visitMethod.

Doc from org.objectweb.asm.ClassVisitor.visitMethod.

Visits a method of the class. This method must return a new MethodVisitor instance (or null) each time it is called, i.e., it should not return a previously returned visitor.

Parameters

access:int: the method's access flags (see Opcodes). This parameter also indicates if the method is synthetic and/or deprecated.
name:String: the method's name.
desc:String: the method's descriptor (see Type).
signature:String: the method's signature. May be null if the method parameters, return type and exceptions do not use generic types.
exceptions:String[]: the internal names of the method's exception classes (see getInternalName). May be null.

Returns:MethodVisitor

an object to visit the byte code of the method, or null if this class visitor is not interested in visiting the code of this method.

org.mortbay.jetty.annotations back to summary

public Class AnnotationFinder.ParsedClass

Class Inheritance

extends AnnotatedStructure

java.lang.Object
org.objectweb.asm.commons.EmptyVisitor
org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure
org.mortbay.jetty.annotations.AnnotationFinder.ParsedClass

ParsedClass A class that contains annotations.

Field Summary

Modifier and Type	Field and Description
pack-priv String	className
pack-priv Class<T>	clazz
pack-priv List<AnnotationFinder.ParsedField>	fields
pack-priv List<AnnotationFinder.ParsedMethod>	methods
pack-priv String	superClassName

Inherited from org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure:: annotations

Constructor Summary

Access	Constructor and Description
public	ParsedClass(String className, String superClassName)

Method Summary

Modifier and Type	Method and Description
public void	addField(AnnotationFinder.ParsedField f)
public void	addMethod(AnnotationFinder.ParsedMethod m)
public String	getClassName()
public AnnotationFinder.ParsedField	getField(String name)
public List<AnnotationFinder.ParsedField>	getFields()
public AnnotationFinder.ParsedMethod	getMethod(String name, String paramString)
public List<AnnotationFinder.ParsedMethod>	getMethods()
public String	getSuperClassName()
public Class<T>	toClass()
public String	toString() Overrides org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure.toString. Returns a string representation of the object.

Inherited from org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure:: addAnnotation getAnnotations

Field Detail

className	back to summary
pack-priv String className

clazz	back to summary
pack-priv Class<T> clazz

fields	back to summary
pack-priv List<AnnotationFinder.ParsedField> fields

methods	back to summary
pack-priv List<AnnotationFinder.ParsedMethod> methods

superClassName	back to summary
pack-priv String superClassName

Constructor Detail

ParsedClass	back to summary
public ParsedClass(String className, String superClassName)

Method Detail

addField	back to summary
public void addField(AnnotationFinder.ParsedField f)

addMethod	back to summary
public void addMethod(AnnotationFinder.ParsedMethod m)

getClassName	back to summary
public String getClassName()

getField	back to summary
public AnnotationFinder.ParsedField getField(String name)

getFields	back to summary
public List<AnnotationFinder.ParsedField> getFields()

getMethod	back to summary
public AnnotationFinder.ParsedMethod getMethod(String name, String paramString)

getMethods	back to summary
public List<AnnotationFinder.ParsedMethod> getMethods()

getSuperClassName	back to summary
public String getSuperClassName()

toClass	back to summary
public Class<T> toClass() throws ClassNotFoundException

toString

back to summary

public String toString()

Overrides org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

org.mortbay.jetty.annotations back to summary

public Class AnnotationFinder.ParsedField

Class Inheritance

extends AnnotatedStructure

java.lang.Object
org.objectweb.asm.commons.EmptyVisitor
org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure
org.mortbay.jetty.annotations.AnnotationFinder.ParsedField

ParsedField A class field that can contain annotations. Also implements the asm visitor for Annotations.

Field Summary

Modifier and Type	Field and Description
pack-priv Field	field
pack-priv String	fieldName
pack-priv AnnotationFinder.ParsedClass	pclass

Inherited from org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure:: annotations

Constructor Summary

Access	Constructor and Description
public	ParsedField(AnnotationFinder.ParsedClass pclass, String name)

Method Summary

Modifier and Type	Method and Description
public boolean	matches(String name)
public Field	toField()
public String	toString() Overrides org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure.toString. Returns a string representation of the object.
public AnnotationVisitor	visitAnnotation(String the class descriptor of the annotation class. desc, boolean `true` if the annotation is visible at runtime. visible) Overrides org.objectweb.asm.commons.EmptyVisitor.visitAnnotation. Implements org.objectweb.asm.ClassVisitor.visitAnnotation, org.objectweb.asm.FieldVisitor.visitAnnotation, org.objectweb.asm.MethodVisitor.visitAnnotation. Visits an annotation of the class.

Inherited from org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure:: addAnnotation getAnnotations

Field Detail

field	back to summary
pack-priv Field field

fieldName	back to summary
pack-priv String fieldName

pclass	back to summary
pack-priv AnnotationFinder.ParsedClass pclass

Constructor Detail

ParsedField	back to summary
public ParsedField(AnnotationFinder.ParsedClass pclass, String name)

Method Detail

matches	back to summary
public boolean matches(String name)

toField	back to summary
public Field toField() throws Exception

toString

back to summary

public String toString()

Overrides org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

visitAnnotation back to summary

public AnnotationVisitor visitAnnotation(String desc, boolean visible)

Overrides org.objectweb.asm.commons.EmptyVisitor.visitAnnotation.

Implements org.objectweb.asm.ClassVisitor.visitAnnotation, org.objectweb.asm.FieldVisitor.visitAnnotation, org.objectweb.asm.MethodVisitor.visitAnnotation.

Doc from org.objectweb.asm.ClassVisitor.visitAnnotation.

Visits an annotation of the class.

Parameters

desc:String: the class descriptor of the annotation class.
visible:boolean: true if the annotation is visible at runtime.

Returns:AnnotationVisitor

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

org.mortbay.jetty.annotations back to summary

public Class AnnotationFinder.ParsedMethod

Class Inheritance

extends AnnotatedStructure

java.lang.Object
org.objectweb.asm.commons.EmptyVisitor
org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure
org.mortbay.jetty.annotations.AnnotationFinder.ParsedMethod

ParsedMethod A class method that can contain annotations.

Field Summary

Modifier and Type	Field and Description
pack-priv Method	method
pack-priv String	methodName
pack-priv String	paramString
pack-priv AnnotationFinder.ParsedClass	pclass

Inherited from org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure:: annotations

Constructor Summary

Access	Constructor and Description
public	ParsedMethod(AnnotationFinder.ParsedClass pclass, String name, String paramString)

Method Summary

Modifier and Type	Method and Description
public boolean	matches(String name, String paramString)
public Method	toMethod()
public String	toString() Overrides org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure.toString. Returns a string representation of the object.
public AnnotationVisitor	visitAnnotation(String the class descriptor of the annotation class. desc, boolean `true` if the annotation is visible at runtime. visible) Overrides org.objectweb.asm.commons.EmptyVisitor.visitAnnotation. Implements org.objectweb.asm.ClassVisitor.visitAnnotation, org.objectweb.asm.FieldVisitor.visitAnnotation, org.objectweb.asm.MethodVisitor.visitAnnotation. Visits an annotation of the class.

Inherited from org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure:: addAnnotation getAnnotations

Field Detail

method	back to summary
pack-priv Method method

methodName	back to summary
pack-priv String methodName

paramString	back to summary
pack-priv String paramString

pclass	back to summary
pack-priv AnnotationFinder.ParsedClass pclass

Constructor Detail

ParsedMethod	back to summary
public ParsedMethod(AnnotationFinder.ParsedClass pclass, String name, String paramString)

Method Detail

matches	back to summary
public boolean matches(String name, String paramString)

toMethod	back to summary
public Method toMethod() throws Exception

toString

back to summary

public String toString()

Overrides org.mortbay.jetty.annotations.AnnotationFinder.AnnotatedStructure.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

visitAnnotation back to summary

public AnnotationVisitor visitAnnotation(String desc, boolean visible)

Overrides org.objectweb.asm.commons.EmptyVisitor.visitAnnotation.

Implements org.objectweb.asm.ClassVisitor.visitAnnotation, org.objectweb.asm.FieldVisitor.visitAnnotation, org.objectweb.asm.MethodVisitor.visitAnnotation.

Doc from org.objectweb.asm.ClassVisitor.visitAnnotation.

Visits an annotation of the class.

Parameters

desc:String: the class descriptor of the annotation class.
visible:boolean: true if the annotation is visible at runtime.

Returns:AnnotationVisitor

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.