org.apache.felix.scrplugin.helper

Class ClassScanner

java.lang.Object

org.apache.felix.scrplugin.helper.ClassScanner

public class ClassScanner
extends java.lang.Object

The class scanner scans class files for annotations and invokes the AnnotationProcessor on each scanned class file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ClassScanner.ArtifactFileInputStream

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ABSTRACT_DESCRIPTOR_ARCHIV_PATH The name of the file containing the scanned information from older SCR generator versions.
private java.util.Map<java.lang.String,ClassDescription>	allDescriptions All used component descriptions.
private AnnotationProcessor	aProcessor The annotation processor.
private static java.util.regex.Pattern	ARRAY_PARAM_TYPE_NAME With this syntax array parameters names are returned by reflection API
private static java.lang.String	GENERATED Source for all generated descriptions.
private IssueLog	iLog The issue log.
private java.util.Map<java.lang.String,ClassDescription>	loadedDependencies Component descriptions loaded from dependencies
private Log	log The log.
private Project	project The project.
private static java.lang.String	SERVICE_COMPONENT The name of the Bundle manifest header providing the list of service component descriptor files.

Constructor Summary

Constructors

Constructor and Description
ClassScanner(Log log, IssueLog iLog, Project project, AnnotationProcessor aProcessor) Create a new scanner.

Method Summary

Modifier and Type	Method and Description
private <T> T[]	convertToArray(java.util.List<?> values, java.lang.Class<T> type)
private java.util.List<ScannedAnnotation>	extractAnnotation(org.objectweb.asm.tree.ClassNode classNode, java.lang.Class<?> annotatedClass) Extract annotations
private java.util.List<org.objectweb.asm.tree.AnnotationNode>	getAllAnnotations(java.util.List<org.objectweb.asm.tree.AnnotationNode>... annotationLists) Method is used to get both invisible (e.g.
private java.util.Map<java.lang.String,ClassDescription>	getComponentDescriptors() Returns a map of component descriptors which may be extended by the java sources.
ClassDescription	getDescription(java.lang.Class<?> clazz) Get a description for the class
private java.io.InputStream	getFile(java.io.File artifactFile, java.lang.String path)
private java.util.jar.Manifest	getManifest(java.io.File artifact) Get the manifest from the artifact.
private void	parseAnnotation(java.util.List<ScannedAnnotation> descriptions, org.objectweb.asm.tree.AnnotationNode annotation, java.lang.Object annotatedObject) Parse annotation and create a description.
private void	process(java.lang.Class<?> annotatedClass, Source src, java.util.List<ClassDescription> result) Process a class
private ClassDescription	processClass(java.lang.Class<?> annotatedClass, java.lang.String location) Scan a single class.
private void	readServiceComponentDescriptor(java.io.File artifactFile, java.lang.String entry) Read the service component description.
private void	readServiceComponentDescriptor(java.io.InputStream file, java.lang.String location) Parses the descriptors read from the given input stream.
java.util.List<ClassDescription>	scanSources() Scan all source class files for annotations and process them.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_COMPONENT

private static final java.lang.String SERVICE_COMPONENT

The name of the Bundle manifest header providing the list of service component descriptor files.

See Also:

Constant Field Values

ABSTRACT_DESCRIPTOR_ARCHIV_PATH

private static final java.lang.String ABSTRACT_DESCRIPTOR_ARCHIV_PATH

The name of the file containing the scanned information from older SCR generator versions.

See Also:

Constant Field Values

GENERATED

private static final java.lang.String GENERATED

Source for all generated descriptions.

See Also:

Constant Field Values

ARRAY_PARAM_TYPE_NAME

private static final java.util.regex.Pattern ARRAY_PARAM_TYPE_NAME

With this syntax array parameters names are returned by reflection API

loadedDependencies

private java.util.Map<java.lang.String,ClassDescription> loadedDependencies

Component descriptions loaded from dependencies

allDescriptions

private final java.util.Map<java.lang.String,ClassDescription> allDescriptions

All used component descriptions.

log

private final Log log

The log.

iLog

private final IssueLog iLog

The issue log.

project

private final Project project

The project.

aProcessor

private final AnnotationProcessor aProcessor

The annotation processor.

Constructor Detail

ClassScanner

public ClassScanner(Log log,
                    IssueLog iLog,
                    Project project,
                    AnnotationProcessor aProcessor)

Create a new scanner.

Method Detail

scanSources

public java.util.List<ClassDescription> scanSources()
                                             throws SCRDescriptorFailureException,
                                                    SCRDescriptorException

Scan all source class files for annotations and process them.

Throws:

SCRDescriptorFailureException

SCRDescriptorException

process

private void process(java.lang.Class<?> annotatedClass,
                     Source src,
                     java.util.List<ClassDescription> result)
              throws SCRDescriptorFailureException,
                     SCRDescriptorException

Process a class

Throws:

SCRDescriptorException

SCRDescriptorFailureException

processClass

private ClassDescription processClass(java.lang.Class<?> annotatedClass,
                                      java.lang.String location)
                               throws SCRDescriptorFailureException,
                                      SCRDescriptorException

Scan a single class.

Throws:

SCRDescriptorFailureException

SCRDescriptorException

extractAnnotation

private final java.util.List<ScannedAnnotation> extractAnnotation(org.objectweb.asm.tree.ClassNode classNode,
                                                                  java.lang.Class<?> annotatedClass)
                                                           throws SCRDescriptorException

Extract annotations

Throws:

SCRDescriptorException

getAllAnnotations

private java.util.List<org.objectweb.asm.tree.AnnotationNode> getAllAnnotations(java.util.List<org.objectweb.asm.tree.AnnotationNode>... annotationLists)

Method is used to get both invisible (e.g. RetentionPolicy.CLASS) and visible (e.g. RetentionPolicy.RUNTIME) annotations. Although it is recommended to use RetentionPolicy.CLASS for SCR annotations, it may make sense to declae them with another RetentionPolicy if the same annotation is used for other usecases which require runtime access as well.

Parameters:

annotationLists - List of invisible and visible annotations.

Returns:

List with all annotations from all lists, or null if none found

convertToArray

private <T> T[] convertToArray(java.util.List<?> values,
                               java.lang.Class<T> type)

parseAnnotation

private void parseAnnotation(java.util.List<ScannedAnnotation> descriptions,
                             org.objectweb.asm.tree.AnnotationNode annotation,
                             java.lang.Object annotatedObject)

Parse annotation and create a description.

getDescription

public ClassDescription getDescription(java.lang.Class<?> clazz)
                                throws SCRDescriptorException,
                                       SCRDescriptorFailureException

Get a description for the class

Throws:

SCRDescriptorException

SCRDescriptorFailureException

getComponentDescriptors

private java.util.Map<java.lang.String,ClassDescription> getComponentDescriptors()
                                                                          throws SCRDescriptorException

Returns a map of component descriptors which may be extended by the java sources.

This method calls the #getDependencies() method and checks for any Service-Component descriptors in the returned files.

This method may be overwritten by extensions of this class.

Throws:

SCRDescriptorException - May be thrown if an error occurs gathering the component descriptors.

readServiceComponentDescriptor

private void readServiceComponentDescriptor(java.io.InputStream file,
                                            java.lang.String location)
                                     throws SCRDescriptorException

Parses the descriptors read from the given input stream. This method may be called by the getComponentDescriptors() method to parse the descriptors gathered in an implementation dependent way.

Throws:

SCRDescriptorException - If an error occurs reading the descriptors from the stream.

readServiceComponentDescriptor

private void readServiceComponentDescriptor(java.io.File artifactFile,
                                            java.lang.String entry)

Read the service component description.

Parameters:

artifact -

entry -

Throws:

java.io.IOException

SCRDescriptorException

getManifest

private java.util.jar.Manifest getManifest(java.io.File artifact)
                                    throws java.io.IOException

Get the manifest from the artifact. The artifact can either be a jar or a directory.

Throws:

java.io.IOException

getFile

private java.io.InputStream getFile(java.io.File artifactFile,
                                    java.lang.String path)
                             throws java.io.IOException

Throws:

java.io.IOException