123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203 |
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- /* $Id$ */
-
- package org.apache.fop.tools;
-
- import java.io.File;
- import java.io.IOException;
- import java.util.Collections;
- import java.util.List;
- import java.util.Map;
-
- import org.apache.fop.events.EventProducer;
- import org.apache.fop.events.model.EventMethodModel;
- import org.apache.fop.events.model.EventModel;
- import org.apache.fop.events.model.EventProducerModel;
- import org.apache.fop.events.model.EventSeverity;
-
- import com.thoughtworks.qdox.JavaDocBuilder;
- import com.thoughtworks.qdox.model.DefaultDocletTagFactory;
- import com.thoughtworks.qdox.model.DocletTag;
- import com.thoughtworks.qdox.model.DocletTagFactory;
- import com.thoughtworks.qdox.model.JavaClass;
- import com.thoughtworks.qdox.model.JavaMethod;
- import com.thoughtworks.qdox.model.JavaParameter;
- import com.thoughtworks.qdox.model.Type;
-
- /**
- * Finds EventProducer interfaces and builds the event model for them.
- */
- class EventProducerCollector {
-
- private static final String CLASSNAME_EVENT_PRODUCER = EventProducer.class.getName();
- private static final Map<String, Class<?>> PRIMITIVE_MAP;
-
- static {
- Map<String, Class<?>> m = new java.util.HashMap<String, Class<?>>();
- m.put("boolean", Boolean.class);
- m.put("byte", Byte.class);
- m.put("char", Character.class);
- m.put("short", Short.class);
- m.put("int", Integer.class);
- m.put("long", Long.class);
- m.put("float", Float.class);
- m.put("double", Double.class);
- PRIMITIVE_MAP = Collections.unmodifiableMap(m);
- }
-
- private DocletTagFactory tagFactory;
- private List<EventModel> models = new java.util.ArrayList<EventModel>();
-
- /**
- * Creates a new EventProducerCollector.
- */
- EventProducerCollector() {
- this.tagFactory = createDocletTagFactory();
- }
-
- /**
- * Creates the {@link DocletTagFactory} to be used by the collector.
- * @return the doclet tag factory
- */
- protected DocletTagFactory createDocletTagFactory() {
- return new DefaultDocletTagFactory();
- }
-
- /**
- * Scans a file and processes it if it extends the {@link EventProducer} interface.
- * @param src the source file (a Java source file)
- * @return true if the file contained an EventProducer interface
- * @throws IOException if an I/O error occurs
- * @throws EventConventionException if the EventProducer conventions are violated
- * @throws ClassNotFoundException if a required class cannot be found
- */
- public boolean scanFile(File src)
- throws IOException, EventConventionException, ClassNotFoundException {
- JavaDocBuilder builder = new JavaDocBuilder(this.tagFactory);
- builder.addSource(src);
- JavaClass[] classes = builder.getClasses();
- boolean eventProducerFound = false;
- for (int i = 0, c = classes.length; i < c; i++) {
- JavaClass clazz = classes[i];
- if (clazz.isInterface() && implementsInterface(clazz, CLASSNAME_EVENT_PRODUCER)) {
- processEventProducerInterface(clazz);
- eventProducerFound = true;
- }
- }
- return eventProducerFound;
- }
-
- private boolean implementsInterface(JavaClass clazz, String intf) {
- JavaClass[] classes = clazz.getImplementedInterfaces();
- for (int i = 0, c = classes.length; i < c; i++) {
- JavaClass cl = classes[i];
- if (cl.getFullyQualifiedName().equals(intf)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Processes an EventProducer interface and creates an EventProducerModel from it.
- * @param clazz the EventProducer interface
- * @throws EventConventionException if the event producer conventions are violated
- * @throws ClassNotFoundException if a required class cannot be found
- */
- protected void processEventProducerInterface(JavaClass clazz)
- throws EventConventionException, ClassNotFoundException {
- EventProducerModel prodMeta = new EventProducerModel(clazz.getFullyQualifiedName());
- JavaMethod[] methods = clazz.getMethods(true);
- for (int i = 0, c = methods.length; i < c; i++) {
- JavaMethod method = methods[i];
- EventMethodModel methodMeta = createMethodModel(method);
- prodMeta.addMethod(methodMeta);
- }
- EventModel model = new EventModel();
- model.addProducer(prodMeta);
- models.add(model);
- }
-
- private EventMethodModel createMethodModel(JavaMethod method)
- throws EventConventionException, ClassNotFoundException {
- JavaClass clazz = method.getParentClass();
- //Check EventProducer conventions
- if (!method.getReturnType().isVoid()) {
- throw new EventConventionException("All methods of interface "
- + clazz.getFullyQualifiedName() + " must have return type 'void'!");
- }
- String methodSig = clazz.getFullyQualifiedName() + "." + method.getCallSignature();
- JavaParameter[] params = method.getParameters();
- if (params.length < 1) {
- throw new EventConventionException("The method " + methodSig
- + " must have at least one parameter: 'Object source'!");
- }
- Type firstType = params[0].getType();
- if (firstType.isPrimitive() || !"source".equals(params[0].getName())) {
- throw new EventConventionException("The first parameter of the method " + methodSig
- + " must be: 'Object source'!");
- }
-
- //build method model
- DocletTag tag = method.getTagByName("event.severity");
- EventSeverity severity;
- if (tag != null) {
- severity = EventSeverity.valueOf(tag.getValue());
- } else {
- severity = EventSeverity.INFO;
- }
- EventMethodModel methodMeta = new EventMethodModel(
- method.getName(), severity);
- if (params.length > 1) {
- for (int j = 1, cj = params.length; j < cj; j++) {
- JavaParameter p = params[j];
- Class<?> type;
- JavaClass pClass = p.getType().getJavaClass();
- if (p.getType().isPrimitive()) {
- type = PRIMITIVE_MAP.get(pClass.getName());
- if (type == null) {
- throw new UnsupportedOperationException(
- "Primitive datatype not supported: " + pClass.getName());
- }
- } else {
- String className = pClass.getFullyQualifiedName();
- type = Class.forName(className);
- }
- methodMeta.addParameter(type, p.getName());
- }
- }
- Type[] exceptions = method.getExceptions();
- if (exceptions != null && exceptions.length > 0) {
- //We only use the first declared exception because that is always thrown
- JavaClass cl = exceptions[0].getJavaClass();
- methodMeta.setExceptionClass(cl.getFullyQualifiedName());
- methodMeta.setSeverity(EventSeverity.FATAL); //In case it's not set in the comments
- }
- return methodMeta;
- }
-
- /**
- * Returns the event model that has been accumulated.
- * @return the event model.
- */
- public List<EventModel> getModels() {
- return this.models;
- }
-
- }
|