org.apache.felix.scrplugin

Class SCRDescriptorGenerator

java.lang.Object

org.apache.felix.scrplugin.SCRDescriptorGenerator

public class SCRDescriptorGenerator
extends java.lang.Object

The SCRDescriptorGenerator class does the hard work of generating the SCR descriptors. This class is being instantiated and configured by clients and the execute() method called to generate the descriptor files.

When using this class carefully consider calling all setter methods to properly configure the generator. All setter method document, which default value is assumed for the respective property if the setter is not called.

Instances of this class are not thread save and should not be reused.

Field Summary

Fields

Modifier and Type	Field and Description
private IssueLog	iLog The issue log.
private Log	logger
private Options	options The options.
private Project	project The project.
private ClassScanner	scanner The annotation scanner.

Constructor Summary

Constructors

Constructor and Description
SCRDescriptorGenerator(Log logger) Create an instance of this generator using the given Log instance of logging.

Method Summary

Modifier and Type	Method and Description
private ComponentContainer	createComponent(ClassDescription desc, IssueLog iLog) Create the SCR objects based on the descriptions
Result	execute() Actually generates the Declarative Services and Metatype descriptors scanning the java sources provided by the setProject(Project)
private void	generateMethods(ComponentContainer container)
private boolean	isPrivateProperty(java.lang.String name)
private void	processGlobalProperties(ClassDescription desc, java.util.Map<java.lang.String,PropertyDescription> allProperties) Add global properties (if not already defined in the component)
private void	processProperties(ClassDescription current, ComponentContainer component, MetatypeContainer ocd) Process property directives
private void	processReferences(ClassDescription current, ComponentContainer component) Process reference directives
private void	processServices(ClassDescription current, ComponentContainer component) Process service directives
void	setOptions(Options p) Set the options.
void	setProject(Project p) Set the project.
private boolean	testProperty(ClassDescription current, java.util.Map<java.lang.String,PropertyDescription> allProperties, PropertyDescription newProperty, boolean isInspectedClass) Test a newly found property
private void	testReference(ClassDescription current, java.util.Map<java.lang.String,ReferenceDescription> allReferences, ReferenceDescription newReference, boolean isInspectedClass) Test a newly found reference

Methods inherited from class java.lang.Object

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

Field Detail

logger

private final Log logger

project

private Project project

The project.

options

private Options options

The options.

scanner

private ClassScanner scanner

The annotation scanner.

iLog

private IssueLog iLog

The issue log.

Constructor Detail

SCRDescriptorGenerator

public SCRDescriptorGenerator(Log logger)

Create an instance of this generator using the given Log instance of logging.

Method Detail

setProject

public void setProject(Project p)

Set the project. This is required.

setOptions

public void setOptions(Options p)

Set the options.

execute

public Result execute()
               throws SCRDescriptorException,
                      SCRDescriptorFailureException

Actually generates the Declarative Services and Metatype descriptors scanning the java sources provided by the setProject(Project)

Returns:

A list of generated file names, relative to the output directory

Throws:

SCRDescriptorException

SCRDescriptorFailureException

generateMethods

private void generateMethods(ComponentContainer container)
                      throws SCRDescriptorException

Throws:

SCRDescriptorException

createComponent

private ComponentContainer createComponent(ClassDescription desc,
                                           IssueLog iLog)
                                    throws SCRDescriptorException

Create the SCR objects based on the descriptions

Throws:

SCRDescriptorException

processServices

private void processServices(ClassDescription current,
                             ComponentContainer component)

Process service directives

isPrivateProperty

private boolean isPrivateProperty(java.lang.String name)

processProperties

private void processProperties(ClassDescription current,
                               ComponentContainer component,
                               MetatypeContainer ocd)

Process property directives

processGlobalProperties

private void processGlobalProperties(ClassDescription desc,
                                     java.util.Map<java.lang.String,PropertyDescription> allProperties)

Add global properties (if not already defined in the component)

testProperty

private boolean testProperty(ClassDescription current,
                             java.util.Map<java.lang.String,PropertyDescription> allProperties,
                             PropertyDescription newProperty,
                             boolean isInspectedClass)

Test a newly found property

processReferences

private void processReferences(ClassDescription current,
                               ComponentContainer component)

Process reference directives

Throws:

SCRDescriptorException

testReference

private void testReference(ClassDescription current,
                           java.util.Map<java.lang.String,ReferenceDescription> allReferences,
                           ReferenceDescription newReference,
                           boolean isInspectedClass)

Test a newly found reference