Examples with Method com.iggroup.oss.restdoclet.doclet.type.Method used on opensource projects

Example 1 with Method

use of com.iggroup.oss.restdoclet.doclet.type.Method in project RESTdoclet by IG-Group.

the class ControllerBuilder method initMethods.

/**
    * Initialises the methods in this controller annotated with
    * <code>@RequestMapping</code> in the source class.
    * 
    * @param classDoc the controller's Java documentation object.
    */
private void initMethods(Controller controller, final ClassDoc classDoc) {
    LOG.info(controller.getName());
    // Controller-level $RequestMapping annotation?
    String baseUri = "";
    AnnotationValue urlAnnotation = elementValue(classDoc, RequestMapping.class, "value");
    if (urlAnnotation != null) {
        String[] methodUris = parseValueAnnotation(urlAnnotation);
        // Assume just one...
        baseUri = methodUris[0];
    }
    // Initialise methods
    ArrayList<Method> methods = new ArrayList<Method>();
    for (int i = 0; classDoc.methods(false) != null && i < classDoc.methods(false).length; i++) {
        if (isAnnotated(classDoc.methods(false)[i], RequestMapping.class) && !ignore(classDoc.methods(false)[i])) {
            methods.add(new MethodBuilder().build(new Method(), classDoc.methods(false)[i], baseUri));
        }
    }
    controller.setMethods(methods);
    if (methods.size() == 0) {
        LOG.warn("No methods found with @RequestMapping tag");
    }
}

Example 2 with Method

use of com.iggroup.oss.restdoclet.doclet.type.Method in project RESTdoclet by IG-Group.

the class RestDocumentationMojo method services.

/**
    * Generates services from the documentation of controllers and
    * data-binders.
    * 
    * @throws BeansNotFoundException if a bean with an identifier or Java type
    *            can't be found.
    * @throws IOException if services can't be marshaled.
    * @throws JavadocNotFoundException if a controller's documentation can't be
    *            found.
    * @throws JiBXException if a JiBX exception occurs.
    */
private void services() throws IOException, JavadocNotFoundException, JiBXException {
    LOG.info("Generating services");
    DirectoryBuilder dirs = new DirectoryBuilder(baseDirectory, outputDirectory);
    int identifier = 1;
    List<Service> services = new ArrayList<Service>();
    LOG.info("Looking for mappings");
    HashMap<String, ArrayList<Method>> uriMethodMappings = new HashMap<String, ArrayList<Method>>();
    HashMap<String, Controller> uriControllerMappings = new HashMap<String, Controller>();
    HashMap<String, Collection<Uri>> multiUriMappings = new HashMap<String, Collection<Uri>>();
    for (Controller controller : controllers) {
        LOG.info(new StringBuilder().append("- Controller ").append(controller.getType()).toString());
        for (Method method : controller.getMethods()) {
            LOG.info(new StringBuilder().append("... for Method ").append(method.toString()));
            if (excludeMethod(method)) {
                continue;
            }
            // Collate multiple uris into one string key.
            Collection<Uri> uris = method.getUris();
            if (!uris.isEmpty()) {
                String multiUri = "";
                for (Uri uri : uris) {
                    multiUri = multiUri + ", " + uri;
                }
                multiUriMappings.put(multiUri, uris);
                ArrayList<Method> methodList = uriMethodMappings.get(multiUri);
                if (methodList == null) {
                    methodList = new ArrayList<Method>();
                    uriMethodMappings.put(multiUri, methodList);
                }
                methodList.add(method);
                uriControllerMappings.put(multiUri, controller);
            }
        }
    }
    LOG.info("Processing controllers...");
    for (String uri : uriControllerMappings.keySet()) {
        LOG.info(new StringBuilder().append("Processing controllers for ").append(uri).toString());
        Controller controller = uriControllerMappings.get(uri);
        LOG.info(new StringBuilder().append("Found controller ").append(uriControllerMappings.get(uri).getType()).toString());
        ArrayList<Method> matches = uriMethodMappings.get(uri);
        LOG.info(new StringBuilder().append("Found methods ").append(matches.toString()).append(" ").append(matches.size()).toString());
        Service service = new Service(identifier, multiUriMappings.get(uri), new Controller(controller.getType(), controller.getJavadoc(), matches));
        services.add(service);
        service.assertValid();
        JiBXUtils.marshallService(service, ServiceUtils.serviceFile(dirs, identifier));
        identifier++;
    }
    LOG.info("Processing services...");
    Services list = new Services();
    for (Service service : services) {
        org.apache.commons.collections.Predicate predicate = new ControllerTypePredicate(service.getController().getType());
        if (CollectionUtils.exists(list.getControllers(), predicate)) {
            ControllerSummary controller = (ControllerSummary) CollectionUtils.find(list.getControllers(), predicate);
            controller.addService(service);
        } else {
            ControllerSummary controller = new ControllerSummary(service.getController().getType(), service.getController().getJavadoc());
            controller.addService(service);
            list.addController(controller);
        }
    }
    LOG.info("Marshalling services...");
    list.assertValid();
    JiBXUtils.marshallServices(list, ServiceUtils.servicesFile(dirs));
}

Example 3 with Method

use of com.iggroup.oss.restdoclet.doclet.type.Method in project RESTdoclet by IG-Group.

the class RestDocumentationMojo method javadocs.

/**
    * Collects documentations of controllers and data-binders.
    * 
    * @throws CloneNotSupportedException if a data-binder's documentation can't
    *            be cloned.
    * @throws FileNotFoundException if the file containing documentation can't
    *            be found.
    * @throws JiBXException if a JiBX exception occurs.
    */
private void javadocs() throws CloneNotSupportedException, FileNotFoundException, JiBXException {
    LOG.info("Collecting controller javadocs");
    /* root directory */
    File root = baseDirectory;
    while (root.getParentFile() != null && new File(root.getParentFile(), MavenUtils.POM_FILE).exists()) {
        root = root.getParentFile();
    }
    /* collect controller javadocs */
    LOG.info("Collecting Controller javadocs");
    final Collection<File> cfiles = ServiceUtils.collectControllerJavadocs(root);
    if (cfiles.size() == 0) {
        throw new IllegalArgumentException("No controller javadoc found.  Is the javadoc plugin configured correctly?");
    }
    for (final File file : cfiles) {
        LOG.debug(file.getAbsolutePath() + File.separatorChar + file.getName());
        final Controller cntrl = JiBXUtils.unmarshallController(file);
        LOG.info(cntrl.getType());
        for (Method m : cntrl.getMethods()) {
            LOG.info(m.toString());
        }
        if (!controllers.contains(cntrl)) {
            controllers.add(cntrl);
        }
    }
}