Package org.apache.fop.tools

Class EventProducerCollector

java.lang.Object

org.apache.fop.tools.EventProducerCollector

class EventProducerCollector
extends Object

Finds EventProducer interfaces and builds the event model for them.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CLASSNAME_EVENT_PRODUCER
private List<EventModel>	models
private static final Map<String,Class<?>>	PRIMITIVE_MAP

Constructor Summary

Constructors

Constructor	Description
EventProducerCollector()	Creates a new EventProducerCollector.

Method Summary

Modifier and Type	Method	Description
private EventMethodModel	createMethodModel(com.thoughtworks.qdox.model.JavaMethod method)
List<EventModel>	getModels()	Returns the event model that has been accumulated.
private boolean	implementsInterface(com.thoughtworks.qdox.model.JavaClass clazz, String intf)
protected void	processEventProducerInterface(com.thoughtworks.qdox.model.JavaClass clazz)	Processes an EventProducer interface and creates an EventProducerModel from it.
boolean	scanFile(File src)	Scans a file and processes it if it extends the EventProducer interface.

Methods inherited from class java.lang.Object

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

Field Details

CLASSNAME_EVENT_PRODUCER

private static final String CLASSNAME_EVENT_PRODUCER

PRIMITIVE_MAP

private static final Map<String,Class<?>> PRIMITIVE_MAP

models

private List<EventModel> models

Constructor Details

EventProducerCollector

EventProducerCollector()

Creates a new EventProducerCollector.

Method Details

scanFile

public boolean scanFile(File src)
                 throws IOException,
EventConventionException,
ClassNotFoundException

Scans a file and processes it if it extends the EventProducer interface.

Parameters:

src - the source file (a Java source file)

Returns:

true if the file contained an EventProducer interface

Throws:

IOException - if an I/O error occurs

EventConventionException - if the EventProducer conventions are violated

ClassNotFoundException - if a required class cannot be found

implementsInterface

private boolean implementsInterface(com.thoughtworks.qdox.model.JavaClass clazz,
 String intf)

processEventProducerInterface

protected void processEventProducerInterface(com.thoughtworks.qdox.model.JavaClass clazz)
                                      throws EventConventionException,
ClassNotFoundException

Processes an EventProducer interface and creates an EventProducerModel from it.

Parameters:

clazz - the EventProducer interface

Throws:

EventConventionException - if the event producer conventions are violated

ClassNotFoundException - if a required class cannot be found

createMethodModel

private EventMethodModel createMethodModel(com.thoughtworks.qdox.model.JavaMethod method)
                                    throws EventConventionException,
ClassNotFoundException

Throws:

EventConventionException

ClassNotFoundException

getModels

public List<EventModel> getModels()

Returns the event model that has been accumulated.

Returns:

the event model.