<change id="source-group-modifier-constants">

            <api name="general"/>

            <summary>Constants for SourceGroupModifier</summary>

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

            <date day="18" month="2" year="2009"/>

            <author login="mkleint"/>

            <compatibility addition="yes"/>

            <description>

                <p>

                    Added a few constants to <code>JavaProjectConstants</code> for use by <code>SourceGroupModifier</code> with relation

                    to java projects.

                </p>

            </description>

            <class package="org.netbeans.api.java.project" name="JavaProjectConstants"/>

            <issue number="102711"/>

        </change>

    /**

     * Hint for <code>SourceGroupModifier</code> to create a <code>SourceGroup</code>

     * for main project codebase.

     * @see org.netbeans.api.project.SourceGroupModifier

     * @since org.netbeans.modules.java.project/1 1.24

     */

    public static final String SOURCES_HINT_MAIN = "main"; //NOI18N

    /**

     * Hint for <code>SourceGroupModifier</code> to create a <code>SourceGroup</code>

     * for project's tests.

     * @see org.netbeans.api.project.SourceGroupModifier

     * @since org.netbeans.modules.java.project/1 1.24

     */

    public static final String SOURCES_HINT_TEST = "test"; //NOI18N

import org.netbeans.spi.project.SourceGroupModifierImplementation;

    public SourceGroup createSourceGroup(String type, String hint) {

        assert type != null;

        MavenProject mp = project.getOriginalMavenProject();

        File folder = null;

        if (JavaProjectConstants.SOURCES_TYPE_JAVA.equals(type)) {

            if (JavaProjectConstants.SOURCES_HINT_MAIN.equals(hint)) {

                folder = FileUtilities.convertStringToFile(mp.getBuild().getSourceDirectory());

            }

            if (JavaProjectConstants.SOURCES_HINT_TEST.equals(hint)) {

                folder = FileUtilities.convertStringToFile(mp.getBuild().getTestSourceDirectory());

            }

        }

        if (folder != null) {

            folder.mkdirs();

            FileUtil.refreshFor(folder);

            checkChanges(false);

            FileObject fo = FileUtil.toFileObject(folder);

            assert fo != null;

            SourceGroup[] grps = getSourceGroups(type);

            for (SourceGroup sg : grps) {

                if (fo.equals(sg.getRootFolder())) {

                    return sg;

                }

            }

            //shall we somehow report it?

        }

        return null;

    }

        <change id="source-group-modifier">

            <api name="general"/>

            <summary>introduction of SourceGroupModifier, a way to create SourceGroup if missing</summary>

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

            <date day="18" month="2" year="2009"/>

            <author login="mkleint"/>

            <compatibility addition="yes"/>

            <description>

                <p>

                    <code>SourceGroupModifier</code> provides ways of create specific folders (<code>SourceGroup</code> root folders)

                    in case they don't exist, eg. cannot be retrieved from <code>Sources</code>.

                    The project supporting automated creation of SourceGroup root folders needs to

                    provide <code>SourceGroupModifierImplementation</code> in the project's lookup.

                </p>

            </description>

            <class package="org.netbeans.api.project" name="SourceGroupModifier"/>

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

            <issue number="102711"/>

        </change>

/*

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

 *

 * Copyright 2009 Sun Microsystems, Inc. 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

 * 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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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 2009 Sun Microsystems, Inc.

 */

package org.netbeans.api.project;

import org.netbeans.spi.project.SourceGroupModifierImplementation;

/**

 * <code>SourceGroupModifier</code> provides ways of create specific folders ({@link org.netbeans.api.project.SourceGroup} root folders)

 * in case they don't exist, eg. cannot be retrieved from {@link org.netbeans.api.project.Sources}

 * The project type supporting automated creation of {@link org.netbeans.api.project.SourceGroup} root folders needs to

 * provide {@link org.netbeans.spi.project.SourceGroupModifierImplementation} in the project's lookup.

 *

 * @since org.netbeans.modules.projectapi 1.24

 * @author mkleint

 */

public final class SourceGroupModifier {

    private SourceGroupModifier() {

    }

    /**

     * Creates a {@link org.netbeans.api.project.SourceGroup} in the given {@link org.netbeans.api.project.Project} of the given type and hint.

     * Typically a type is a constant for java/groovy/ruby source roots and hint is a constant for main sources or test sources.

     * Please consult specific APIs fro the supported types/hints. Eg. <code>JavaProjectConstants</code> for java related project sources.

     *

     * @param project

     * @param type constant for type of sources

     * @param hint

     * @return the created SourceGroup or null

     */

    public static final SourceGroup createSourceGroup(Project project, String type, String hint) {

        assert project != null;

        SourceGroupModifierImplementation impl = project.getLookup().lookup(SourceGroupModifierImplementation.class);

        if (impl == null) {

            return null;

        }

        return impl.createSourceGroup(type, hint);

    }

    /**

     * Creates a {@link org.netbeans.api.project.SourceGroupModifier.Future} object

     * that is capable of lazily creating {@link org.netbeans.api.project.SourceGroup} in the given {@link org.netbeans.api.project.Project} of the given type and hint.

     * Typically a type is a constant for java/groovy/ruby source roots and hint is a constant for main sources or test sources.

     * Please consult specific APIs fro the supported types/hints. Eg. <code>JavaProjectConstants</code> for java related project sources.

     * @param project

     * @param type

     * @param hint

     * @return Future instance that is capable of creating a SourceGroup or null

     */

    public static final SourceGroupModifier.Future createSourceGroupFuture(Project project, String type, String hint) {

        assert project != null;

        SourceGroupModifierImplementation impl = project.getLookup().lookup(SourceGroupModifierImplementation.class);

        if (impl == null) {

            return null;

        }

        return new Future(impl, type, hint);

    }

    /**

     * A wrapper class that is capable of lazily creating a {@link org.netbeans.api.project.SourceGroup} instance.

     */

    public static final class Future {

        SourceGroupModifierImplementation impl;

        private String hint;

        private String type;

        private Future(SourceGroupModifierImplementation im, String type, String hint) {

            this.impl = im;

            this.hint = hint;

            this.type = type;

        }

        /**

         * Create the instance of {@link org.netbeans.api.project.SourceGroup} wrapped by

         * this object.

         * @param type

         * @param hint

         * @return

         */

        public final SourceGroup createSourceGroup() {

            return impl.createSourceGroup(type, hint);

        }

        public String getType() {

            return type;

        }

        public String getHint() {

            return hint;

        }

    }

}

/*

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

 *

 * Copyright 2009 Sun Microsystems, Inc. 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

 * 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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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 2009 Sun Microsystems, Inc.

 */

package org.netbeans.spi.project;

import org.netbeans.api.project.SourceGroup;

/**

 * The SPI side of {@link org.netbeans.api.project.SourceGroupModifier}.

 * Expected to be present in project lookup of project types supporting automated creation

 * of {@link org.netbeans.api.project.SourceGroup} root folders.

 * @since org.netbeans.modules.projectapi 1.24

 * @author mkleint

 */

public interface SourceGroupModifierImplementation {

    /**

     * Creates a {@link org.netbeans.api.project.SourceGroup} of the given type and hint.

     * Typically a type is a constant for java/groovy/ruby source roots and hint is a constant for main sources or test sources.

     * Please consult specific APIs fro the supported types/hints. Eg. <code>JavaProjectConstants</code> for java related project sources.

     * If the SourceGroup's type/hint is not supported, the implementation shall silently return null and not throw any exceptions.

     * If the SourceGroup of given type/hint already exists it shall be returned as well.

     *

     * @param project

     * @param type constant for type of sources

     * @param hint

     * @return the created or existing SourceGroup or null

     */

    public SourceGroup createSourceGroup(String type, String hint);

}