import org.netbeans.spi.java.project.classpath.support.ProjectClassPathSupport;

        <apidef name="classpath">Classpath Support SPI</apidef>

  <api group="java" name="ProjectClassPathSupport" type="export" category="devel">

   <p>

    Support class containg helper method for creating ClassPathImplementation based

    on the Ant properies.

   </p>

  </api>

		<package>org.netbeans.spi.java.project.classpath.support</package>

/*

 *                 Sun Public License Notice

 *

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 *

 * The Original Code is NetBeans. The Initial Developer of the Original

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2004 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.spi.java.project.classpath.support;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.beans.PropertyChangeSupport;

import java.io.File;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.HashSet;

import java.util.List;

import java.util.Set;

import org.netbeans.api.project.ProjectManager;

import org.netbeans.spi.java.classpath.ClassPathImplementation;

import org.netbeans.spi.java.classpath.support.ClassPathSupport;

import org.netbeans.spi.project.support.ant.AntProjectHelper;

import org.netbeans.spi.project.support.ant.PropertyEvaluator;

import org.netbeans.spi.project.support.ant.PropertyUtils;

import org.openide.filesystems.FileUtil;

import org.openide.util.WeakListeners;

/**

 * Implementation of a single classpath that is derived from list of Ant properties.

 */

final class ProjectClassPathImplementation implements ClassPathImplementation, PropertyChangeListener, Runnable {

    private final PropertyChangeSupport support = new PropertyChangeSupport(this);

    private final AntProjectHelper helper;

    private final String[] propertyNames;

    private List resources;

    private final PropertyEvaluator evaluator;

    private boolean dirty = false;

    private final Set/*<String>*/ propertyNamesSet = new HashSet ();

    /**

     * Construct the implementation.

     * @param helper an Ant project, used to resolve file paths

     * @param propertyNames the names of an Ant properties which will supply the classpath

     * @param evaluator a property evaluator used to find the value of the classpath

     */

    public ProjectClassPathImplementation(AntProjectHelper helper, String[] propertyNames, PropertyEvaluator evaluator) {

        assert helper != null && propertyNames != null && evaluator != null;

        this.helper = helper;

        this.evaluator = evaluator;

        this.propertyNames = propertyNames;

        this.propertyNamesSet.addAll(Arrays.asList(propertyNames));

        evaluator.addPropertyChangeListener(WeakListeners.propertyChange(this, evaluator));

    }

    public synchronized List /*<PathResourceImplementation>*/ getResources() {

        if (this.resources == null) {

            this.resources = this.getPath ();

        }

        return this.resources;

    }

    public void addPropertyChangeListener(PropertyChangeListener listener) {

        support.addPropertyChangeListener (listener);

    }

    public void removePropertyChangeListener(PropertyChangeListener listener) {

        support.removePropertyChangeListener (listener);

    }

    public void propertyChange(PropertyChangeEvent evt) {        

        if (!this.propertyNamesSet.contains(evt.getPropertyName())) {

            // Not interesting to us.

            return;

        }

        // Coalesce changes; can come in fast after huge CP changes (#47910):

        if (!dirty) {

            dirty = true;

            ProjectManager.mutex().postReadRequest(this);

        }

    }

    public void run() {

        dirty = false;

        List newRoots = getPath ();

        boolean fire = false;

        synchronized (this) {

            if (this.resources != null && !this.resources.equals(newRoots)) {

                this.resources = newRoots;

                fire = true;

            }

        }

        if (fire) {

            support.firePropertyChange (PROP_RESOURCES,null,null);

        }

    }

    private List getPath() {

        List result = new ArrayList ();

        for (int j=0; j< propertyNames.length; j++) {

            String prop = evaluator.getProperty(propertyNames[j]);

            if (prop != null) {

                String[] pieces = PropertyUtils.tokenizePath(prop);

                for (int i = 0; i < pieces.length; i++) {

                    File f = helper.resolveFile(pieces[i]);

                    try {

                        URL entry = f.toURI().toURL();

                        if (FileUtil.isArchiveFile(entry) || (f.isFile() && f.length()<4)) {    //XXX: Not yet closed archive file

                            entry = FileUtil.getArchiveRoot(entry);

                        } else if (!f.exists()) {

                            // if file does not exist (e.g. build/classes folder

                            // was not created yet) then corresponding File will

                            // not be ended with slash. Fix that.

                            assert !entry.toExternalForm().endsWith("/") : f; // NOI18N

                            entry = new URL(entry.toExternalForm() + "/"); // NOI18N

                        }

                        result.add(ClassPathSupport.createResource(entry));

                    } catch (MalformedURLException mue) {

                        assert false : mue;

                    }

                }

            }

        }

        return Collections.unmodifiableList(result);

    }

}

/*

 *                 Sun Public License Notice

 *

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 *

 * The Original Code is NetBeans. The Initial Developer of the Original

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.spi.java.project.classpath.support;

import org.netbeans.spi.java.classpath.ClassPathImplementation;

import org.netbeans.spi.project.support.ant.AntProjectHelper;

import org.netbeans.spi.project.support.ant.PropertyEvaluator;

/**

 * ProjectClassPathSupport is a support class for creating classpath based

 * on the list of ant properties.

 * @since org.netbeans.modules.java.project 1.3 

 * @author Tomas Zezula

 */

public class ProjectClassPathSupport {

    /** Creates a new instance of NewClass */

    private ProjectClassPathSupport() {

    }

    /**

     * Creates new classpath based on the ant property. The returned classpath

     * listens on changes of property value.

     * @param helper {@link AntProjectHelper} used to resolve files

     * @param evaluator {@link PropertyEvaluator} used for obtaining the value of

     * given property and listening on value changes.

     * @param propertyNames the names of ant properties the classpath will be build on,

     * can't be or contain null. It can contain duplicates, in this case the duplicated property

     * is used multiple times.

     */

    public static ClassPathImplementation createPropertyBasedClassPathImplementation (AntProjectHelper helper,

            PropertyEvaluator evaluator, String[] propertyNames) {

        return new ProjectClassPathImplementation (helper, propertyNames, evaluator);

    }

}

/*

 *                 Sun Public License Notice

 *

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 *

 * The Original Code is NetBeans. The Initial Developer of the Original

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.spi.java.project.classpath.support;

import java.io.File;

import java.io.IOException;

import java.net.URL;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.List;

import java.util.Map;

import java.util.Properties;

import org.netbeans.api.java.classpath.ClassPath;

import org.netbeans.api.project.Project;

import org.netbeans.api.project.ProjectManager;

import org.netbeans.junit.NbTestCase;

import org.netbeans.spi.java.classpath.ClassPathFactory;

import org.netbeans.spi.java.classpath.ClassPathImplementation;

import org.netbeans.spi.java.classpath.support.ClassPathSupport;

import org.netbeans.spi.project.support.ant.AntBasedTestUtil;

import org.netbeans.spi.project.support.ant.PropertyEvaluator;

import org.netbeans.spi.project.support.ant.PropertyUtils;

import org.openide.filesystems.FileObject;

import org.netbeans.api.project.TestUtil;

import org.netbeans.spi.project.support.ant.AntProjectHelper;

import org.netbeans.spi.project.support.ant.EditableProperties;

import org.netbeans.spi.project.support.ant.ProjectGenerator;

import org.openide.filesystems.FileUtil;

import org.openide.filesystems.Repository;

import org.openide.util.Lookup;

/**

 * Tests for {@link ProjectClassPathImplementation}.

 * @author Tomas Zezula

 */

public class ProjectClassPathImplementationTest extends NbTestCase {

    private static final String PROP_NAME_1 = "classpath1"; //NOI18N

    private static final String PROP_NAME_2 = "classpath2"; //NOI18N

    public ProjectClassPathImplementationTest(String testName) {

        super(testName);

    }

    private FileObject scratch;

    private FileObject projdir;

    private FileObject[] cpRoots1;

    private FileObject[] cpRoots2;

    private AntProjectHelper helper;

    private PropertyEvaluator evaluator;

    protected void setUp() throws Exception {

        super.setUp();

        TestUtil.setLookup(new Object[] {

            new org.netbeans.modules.projectapi.SimpleFileOwnerQueryImplementation(),

            AntBasedTestUtil.testAntBasedProjectType(),

        }, ProjectClassPathImplementation.class.getClassLoader());

    }

    protected void tearDown() throws Exception {

        scratch = null;

        projdir = null;

        cpRoots1 = null;

        cpRoots2 = null;

        helper = null;

        evaluator = null;

        TestUtil.setLookup(Lookup.EMPTY);

        super.tearDown();

    }

    private void prepareProject () throws IOException {

        scratch = TestUtil.makeScratchDir(this);

        projdir = scratch.createFolder("proj"); //NOI18N

        cpRoots1 = new FileObject[2];

        cpRoots1[0] = scratch.createFolder("cpRoot1"); //NOI18N

        cpRoots1[1] = scratch.createFolder("cpRoot2"); //NOI18N

        cpRoots2[0] = scratch.createFolder("cpRoot3"); //NOI18N

        cpRoots2[1] = scratch.createFolder("cpRoot4"); //NOI18N

        helper = ProjectGenerator.createProject(projdir, "test"); //NOI18N                

        evaluator = helper.getStandardPropertyEvaluator();

        setClassPath(new String[] {}, new FileObject[][] {cpRoots1, cpRoots2});

    }

    public void testBootClassPathImplementation () throws Exception {

        prepareProject();

        ClassPathImplementation cpImpl = ProjectClassPathSupport.createPropertyBasedClassPathImplementation(helper, evaluator, new String[] {PROP_NAME_1, PROP_NAME_2});

        ClassPath cp = ClassPathFactory.createClassPath(cpImpl);

        FileObject[] fo = cp.getRoots();

        List expected = new ArrayList ();

        expected.addAll(Arrays.asList(cpRoots1));

        expected.addAll(Arrays.asList(cpRoots2));

        assertEquals ("Wrong ClassPath roots",expected, Arrays.asList(fo));   //NOI18N

        cpRoots1 = new FileObject[] {cpRoots1[0]};

        setClassPath(new String[] {PROP_NAME_1}, new FileObject[][]{cpRoots1});

        fo = cp.getRoots();

        expected = new ArrayList ();

        expected.addAll(Arrays.asList(cpRoots1));

        expected.addAll(Arrays.asList(cpRoots2));

        assertEquals ("Wrong ClassPath roots",expected, Arrays.asList(fo));   //NOI18N

        cpRoots2 = new FileObject[] {cpRoots2[0]};

        setClassPath(new String[] {PROP_NAME_2}, new FileObject[][]{cpRoots2});

        fo = cp.getRoots();

        expected = new ArrayList ();

        expected.addAll(Arrays.asList(cpRoots1));

        expected.addAll(Arrays.asList(cpRoots2));

        assertEquals ("Wrong ClassPath roots",expected, Arrays.asList(fo));   //NOI18N

    }        

    private void setClassPath (String[] propNames, FileObject[][] cpRoots) {

        EditableProperties props = helper.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);

        for (int i=0; i< propNames.length; i++) {

            props.setProperty (propNames[i],toPath(cpRoots[i]));

        }                

        helper.putProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH, props);

    }

    private static String toPath (FileObject[] cpRoots) {

        StringBuffer result = new StringBuffer ();

        for (int i=0; i<cpRoots.length; i++) {

            if (i>0) {

                result.append(':'); //NOI18N

            }

            File f = FileUtil.toFile (cpRoots[i]);

            result.append (f.getAbsolutePath());

        }

        return result.toString();

    }

}