com.sun.enterprise.tools.apt.MetainfServiceGenerator Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007-2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.enterprise.tools.apt;

import com.sun.mirror.apt.AnnotationProcessor;
import com.sun.mirror.apt.AnnotationProcessorEnvironment;
import com.sun.mirror.apt.AnnotationProcessorFactory;
import com.sun.mirror.apt.AnnotationProcessors;
import com.sun.mirror.declaration.AnnotationTypeDeclaration;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Set;

/**
 * {@link AnnotationProcessorFactory} implementation to generate META-INF/services
 * by scanning {@link org.jvnet.hk2.annotations.Service}.
 *
 * @author Jerome Dochez
 */
public class MetainfServiceGenerator implements AnnotationProcessorFactory {

    /**
     * Although I should theorically only return @Service annotation, I
     * use this trick of returning '*' so I have my annoation processor called
     * even if the @Service class is not present on the source file.
     * This is very useful when a class that used to be annotated with @Service
     * is not anymore so that I can remove it from the existing generated
     * META-INF/services file.
     */
    private static final Collection supportedAnnotations
        = Collections.unmodifiableCollection(Arrays.asList("*"));

    // We only support debugging option
    private static final Collection supportedOptions = Arrays.asList("-Adebug");

    private DescriptorList list = new DescriptorList();

    public Collection supportedAnnotationTypes() {
        return supportedAnnotations;
    }

    public Collection supportedOptions() {
        return supportedOptions;
    }

    public AnnotationProcessor getProcessorFor(
            Set atds,
            AnnotationProcessorEnvironment env) {

        list.loadExisting(env);

        return AnnotationProcessors.getCompositeAnnotationProcessor(
                new CompanionSeedGenerator(env),
                new InhabitantsGenerator(env,list));
        
    }
}