#193549

org.netbeans.modules.maven.NbMavenProjectFactory

        <change id="ProjectFactory.Registration">

            <api name="general"/>

            <summary>Register ProjectFactory lazily</summary>

            <version major="1" minor="43"/>

            <date day="24" month="1" year="2012"/>

            <author login="jtulach"/>

            <compatibility source="compatible" binary="compatible" addition="yes" semantic="compatible"/>

            <description>

                <p>

                    New lazy annotation to register <code>ProjectFactory</code>.

                </p>

            </description>

            <class package="org.netbeans.spi.project" name="ProjectFactory"/>

            <issue number="193549"/>

        </change>

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * 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

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. 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

 * nbbuild/licenses/CDDL-GPL-2-CP.  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. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * 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 do not 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.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2010 Sun Microsystems, Inc.

 */

package org.netbeans.modules.projectapi;

import java.io.IOException;

import java.util.ArrayList;

import java.util.List;

import java.util.Map;

import org.netbeans.api.project.Project;

import org.netbeans.api.project.ProjectManager.Result;

import org.netbeans.spi.project.ProjectFactory;

import org.netbeans.spi.project.ProjectFactory2;

import org.netbeans.spi.project.ProjectState;

import org.openide.filesystems.FileObject;

import org.openide.util.ImageUtilities;

/**

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

public final class GenericProjectFactory implements ProjectFactory2 {

    private final List<String> relativeFiles;

    private final Map<?,?> map;

    private volatile ProjectFactory delegate;

    private GenericProjectFactory(Map<?,?> map) {

        this.map = map;

        List<String> arr = new ArrayList<String>();

        for (int cnt = 0;; cnt++) {

            Object attr = map.get("relativeFile." + cnt); // NOI18N

            if (attr instanceof String) {

                arr.add((String) attr);

            } else {

                break;

            }

        }

        this.relativeFiles = arr;

    }

    synchronized ProjectFactory delegate() {

        if (delegate == null) {

            delegate = (ProjectFactory)map.get("delegate"); // NOI18N

        }

        return delegate;

    }

    public static GenericProjectFactory create(Map fo) {

        return new GenericProjectFactory(fo);

    }

    @Override

    public Result isProject2(FileObject projectDirectory) {

        if (isProject(projectDirectory)) {

            if (delegate instanceof ProjectFactory2) {

                return ((ProjectFactory2)delegate).isProject2(projectDirectory);

            }

            String iconBase = (String)map.get("iconBase"); // NOI18N

            return new Result(ImageUtilities.loadImageIcon(iconBase, true));

        }

        return null;

    }

    @Override

    public boolean isProject(FileObject projectDirectory) {

        for (String rp: relativeFiles) {

            FileObject fo = projectDirectory.getFileObject(rp);

            if (fo != null) {

                return true;

            }

        }

        return false;

    }

    @Override

    public Project loadProject(FileObject projectDirectory, ProjectState state) throws IOException {

        if (isProject(projectDirectory)) {

            return delegate().loadProject(projectDirectory, state);

        } else {

            return null;

        }

    }

    @Override

    public void saveProject(Project project) throws IOException, ClassCastException {

        if (delegate != null) {

            delegate.saveProject(project);

        }

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2010 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * 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

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. 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

 * nbbuild/licenses/CDDL-GPL-2-CP.  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. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * 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 do not 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.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2010 Sun Microsystems, Inc.

 */

package org.netbeans.modules.projectapi;

import java.util.Collections;

import java.util.Set;

import javax.annotation.processing.Processor;

import javax.annotation.processing.RoundEnvironment;

import javax.annotation.processing.SupportedAnnotationTypes;

import javax.annotation.processing.SupportedSourceVersion;

import javax.lang.model.SourceVersion;

import javax.lang.model.element.Element;

import javax.lang.model.element.TypeElement;

import org.netbeans.spi.project.ProjectFactory;

import org.netbeans.spi.project.ProjectFactory.Registration;

import org.openide.filesystems.annotations.LayerBuilder.File;

import org.openide.filesystems.annotations.LayerGeneratingProcessor;

import org.openide.filesystems.annotations.LayerGenerationException;

import org.openide.util.lookup.ServiceProvider;

/**

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

@SupportedSourceVersion(SourceVersion.RELEASE_6)

@ServiceProvider(service=Processor.class)

public final class GenericProjectProcessor extends LayerGeneratingProcessor {

    @Override

    public Set<String> getSupportedAnnotationTypes() {

        return Collections.singleton(Registration.class.getCanonicalName());

    }

    @Override

    protected boolean handleProcess(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) throws LayerGenerationException {

        for (Element e : roundEnv.getElementsAnnotatedWith(Registration.class)) {

            Registration pr = e.getAnnotation(Registration.class);

            File f = layer(e).instanceFile("Services/ProjectFactories", null, ProjectFactory.class); // NOI18N

            f.methodvalue("instanceCreate", GenericProjectFactory.class.getName(), "create"); // NOI18N

            f.instanceAttribute("delegate", ProjectFactory.class); // NOI18N

            if (!pr.iconBase().isEmpty()) {

                f.stringvalue("iconBase", pr.iconBase()); // NOI18N

            }

            f.position(pr.position());

            int cnt = 0;

            for (String p : pr.requiredFile()) {

                f.stringvalue("relativeFile." + cnt++, p); // NOI18N

            }

            f.write();

        }

        return true;

    }

}

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

    /** Registers a project factory in a lazy way. The factory instance creation

     * is delayed until one of files specified by {@link #requiredFile()} appears

     * on the disk. As soon as the real factory is created all operations are

     * delegated to it. The factory may implement {@link ProjectFactory2} or

     * directly specify path to icon via {@link #iconBase} attribute.

     * 

     * @since 1.43

     */

    @Retention(RetentionPolicy.SOURCE)

    @Target({ ElementType.METHOD, ElementType.TYPE })

    public @interface Registration {

        /** Relative path(s) to file under the project directory which

         * must be present to activate this factory. If more than one path

         * is specified, then presence of any of these files activates the

         * factory.

         * @return relative path(s) to files that trigger this registration

         */

        public String[] requiredFile();

        /** Path to icon to represent the project. 

         */

        public String iconBase() default "";

        /** The relative position of the registration */

        public int position() default Integer.MAX_VALUE;

    }

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * 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

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. 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

 * nbbuild/licenses/CDDL-GPL-2-CP.  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. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * 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 do not 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.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.spi.project;

import java.io.IOException;

import javax.swing.Icon;

import org.netbeans.api.project.Project;

import org.netbeans.api.project.ProjectManager;

import org.netbeans.api.project.ProjectManager.Result;

import org.netbeans.junit.NbTestCase;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileUtil;

import org.openide.modules.ModuleInfo;

import org.openide.util.ImageUtilities;

import org.openide.util.Lookup;

public class ProjectFactoryTest extends NbTestCase {

    private FileObject dir;

    static boolean created;

    public ProjectFactoryTest(String n) {

        super(n);

    }

    @Override

    protected void setUp() throws Exception {

        clearWorkDir();

        Lookup.getDefault().lookup(ModuleInfo.class);

        FileObject root = FileUtil.toFileObject(getWorkDir());

        FileObject fo = FileUtil.createData(root, "dir/project/mark");

        dir = fo.getParent();

    }

    public void testRecognizeDirectory() throws Exception {

        Project r1 = ProjectManager.getDefault().findProject(dir.getParent());

        assertNull("Not a project", r1);

        assertFalse("Not created yet", created);

        assertTrue("Project recognized", ProjectManager.getDefault().isProject(dir));

        Result r3 = ProjectManager.getDefault().isProject2(dir);

        assertNotNull("Project found", r3);

        assertEquals("Icons are the same", icon(), r3.getIcon());

        assertFalse("Factory not yet created", created);

        Project r2 = ProjectManager.getDefault().findProject(dir);

        assertNull("Again not recognized, but via factory", r2);

        assertTrue("Factory created", created);

    }

    private static final String PATH = "org/netbeans.api/project/resources/icon-1.png";

    private static Icon icon() {

        return ImageUtilities.loadImageIcon(PATH, true);

    }

    @ProjectFactory.Registration(

        iconBase=PATH,

        requiredFile="mark"

    )

    public static final class Fact implements ProjectFactory {

        public Fact() {

            created = true;

        }

        @Override

        public boolean isProject(FileObject projectDirectory) {

            return projectDirectory.getFileObject("mark") != null;

        }

        @Override

        public Project loadProject(FileObject projectDirectory, ProjectState state) throws IOException {

            return null;

        }

        @Override

        public void saveProject(Project project) throws IOException, ClassCastException {

        }

    }

}