org.codehaus.plexus.metadata.SourceComponentDescriptorExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plexus-component-metadata Show documentation

A Maven plugin to generate Plexus Components descriptors from source javadoc tags and Java class annotations.

The newest version!

/*
 * Copyright (C) 2007 the original author or authors.
 *
 * Licensed 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.
 */

package org.codehaus.plexus.metadata;

import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import com.thoughtworks.qdox.JavaProjectBuilder;
import com.thoughtworks.qdox.model.JavaClass;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.repository.ComponentDescriptor;
import org.codehaus.plexus.metadata.gleaner.QDoxComponentGleaner;
import org.codehaus.plexus.metadata.gleaner.SourceComponentGleaner;
import org.codehaus.plexus.util.StringUtils;

/**
 * Extracts {@link ComponentDescriptor} from source files.
 *
 * @version $Rev$ $Date$
 */
@Component(role = ComponentDescriptorExtractor.class, hint = "source")
public class SourceComponentDescriptorExtractor extends ComponentDescriptorExtractorSupport {
    private SourceComponentGleaner gleaner;

    public SourceComponentDescriptorExtractor() {}

    public SourceComponentDescriptorExtractor(final SourceComponentGleaner gleaner) {
        this.gleaner = gleaner;
    }

    public List> extract(
            MetadataGenerationRequest configuration, final ComponentDescriptor[] roleDefaults) throws Exception {
        if (gleaner == null) {
            gleaner = new QDoxComponentGleaner();
        }

        return extract(configuration.sourceDirectories, configuration.sourceEncoding, getDefaultsByRole(roleDefaults));
    }

    private List> extract(
            final List sourceDirectories,
            final String sourceEncoding,
            final Map> defaultsByRole)
            throws Exception {
        assert sourceDirectories != null;
        assert defaultsByRole != null;

        List> descriptors = new ArrayList>();

        // Scan the sources
        JavaProjectBuilder builder = new JavaProjectBuilder();

        if (StringUtils.isNotEmpty(sourceEncoding)) {
            builder.setEncoding(sourceEncoding);
        }

        for (String sourceDirectory : sourceDirectories) {
            File dir = new File(sourceDirectory);

            builder.addSourceTree(dir);
        }

        Collection classes = builder.getClasses();

        // For each class we find, try to glean off a descriptor
        for (JavaClass aClass : classes) {
            ComponentDescriptor descriptor = gleaner.glean(builder, aClass);

            if (descriptor != null) {
                applyDefaults(descriptor, defaultsByRole);

                descriptors.add(descriptor);
            }
        }

        return descriptors;
    }
}