<change id="SharabilityQueryBasedOnURI">

        <api name="general"/>

        <summary>SharabilityQuery and CollocationQuery extended to use URI</summary>

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

        <date day="22" month="12" year="2011"/>

        <author login="alexvsimon"/>

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

        </compatibility>

        <description>

          <p>

             Added new service ProjectSharabilityQuery2 that delegate implementation of SharabilityQueryImplementation2 to project.

          </p>

        </description>

        <class package="org.netbeans.modules.projectapi" name="ProjectSharabilityQuery2"/>

        <issue number="198060"/>

      </change>

/*

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

 *

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

 */

package org.netbeans.modules.projectapi;

import org.netbeans.spi.queries.SharabilityQueryImplementation2;

import java.net.URI;

import org.netbeans.api.project.FileOwnerQuery;

import org.netbeans.api.project.Project;

import org.netbeans.api.queries.SharabilityQuery;

import org.netbeans.api.queries.SharabilityQuery.Sharability;

/**

 * Delegates {@link SharabilityQuery} to implementations in project lookup.

 * @author Jesse Glick

 * @author Alexander Simon

 */

@org.openide.util.lookup.ServiceProvider(service=org.netbeans.spi.queries.SharabilityQueryImplementation2.class)

public class ProjectSharabilityQuery2 implements SharabilityQueryImplementation2 {

    public ProjectSharabilityQuery2() {}

    @Override

    public Sharability getSharability(URI uri) {

        Project p = FileOwnerQuery.getOwner(uri);

        if (p != null) {

            SharabilityQueryImplementation2 sqi = p.getLookup().lookup(SharabilityQueryImplementation2.class);

            if (sqi != null) {

                return sqi.getSharability(uri);

            }

        }

        return Sharability.UNKNOWN;

    }

}

       <change id="SharabilityQueryBasedOnURI">

        <api name="general"/>

        <summary>SharabilityQuery and CollocationQuery extended to use URI</summary>

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

        <date day="22" month="12" year="2011"/>

        <author login="alexvsimon"/>

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

        </compatibility>

        <description>

          <p>

             Added new methods CollocationQuery.areCollocated(URI, URI) and CollocationQuery.findRoot(URI).

             Methods query all CollocationQueryImplementation (if pissible) and CollocationQueryImplementation2 instances found in global lookup.

             Depricated existing methods CollocationQuery.areCollocated(File, File) and CollocationQuery.findRoot(File).

             Methods query all CollocationQueryImplementation and CollocationQueryImplementation2 instances found in global lookup.

          </p>

          <p>

             Added new methods SharabilityQuery.getSharability(URI) and SharabilityQuery.getSharability(FileObject).

             Methods query all SharabilityQueryImplementation (if pissible) and SharabilityQueryImplementation2 instances found in global lookup.

             Depricated existing method SharabilityQuery.getSharability(File).

             Method query all SharabilityQueryImplementation and SharabilityQueryImplementation2 instances found in global lookup.

          </p>

        </description>

        <class package="org.netbeans.api.queries" name="CollocationQuery"/>

        <class package="org.netbeans.api.queries" name="SharabilityQuery"/>

        <class package="org.netbeans.spi.queries" name="CollocationQueryImplementation"/>

        <class package="org.netbeans.spi.queries" name="CollocationQueryImplementation2"/>

        <class package="org.netbeans.spi.queries" name="SharabilityQueryImplementation"/>

        <class package="org.netbeans.spi.queries" name="SharabilityQueryImplementation2"/>

        <issue number="198060"/>

      </change>

import java.net.URI;

import org.netbeans.spi.queries.CollocationQueryImplementation2;

    private static final Lookup.Result<CollocationQueryImplementation2> implementations2 =

        Lookup.getDefault().lookupResult(CollocationQueryImplementation2.class);

     * @deprecated Use {@link org.netbeans.api.queries.CollocationQuery#areCollocated(java.net.URI, java.net.URI)} instead.

        URI uri1 = file1.toURI();

        URI uri2 = file2.toURI();

        for (CollocationQueryImplementation2 cqi : implementations2.allInstances()) {

            if (cqi.areCollocated(uri1, uri2)) {

                return true;

            }

        }

    /**

     * Check whether two files are logically part of one directory tree.

     * For example, if both files are stored in CVS, with the same server

     * (<code>CVSROOT</code>) they might be considered collocated.

     * If nothing is known about them, return false.

     * @param file1 one file

     * @param file2 another file

     * @return true if they are probably part of one logical tree

     * @since 1.27

     */

    public static boolean areCollocated(URI file1, URI file2) {

        if (!file1.equals(file1.normalize())) {

            throw new IllegalArgumentException("Parameter file1 was not "+  // NOI18N

                "normalized. Was "+file1+" instead of "+file1.normalize());  // NOI18N

        }

        if (!file2.equals(file2.normalize())) {

            throw new IllegalArgumentException("Parameter file2 was not "+  // NOI18N

                "normalized. Was "+file2+" instead of "+file2.normalize());  // NOI18N

        }

        for (CollocationQueryImplementation2 cqi : implementations2.allInstances()) {

            if (cqi.areCollocated(file1, file2)) {

                return true;

            }

        }

        if ("file".equals(file1.getScheme()) && "file".equals(file2.getScheme())) { // NOI18N

            File f1 = FileUtil.normalizeFile(new File(file1));

            File f2 = FileUtil.normalizeFile(new File(file2));

            for (CollocationQueryImplementation cqi : implementations.allInstances()) {

                if (cqi.areCollocated(f1, f2)) {

                    return true;

                }

            }

        }

        return false;

    }

     * @deprecated Use {@link org.netbeans.api.queries.CollocationQuery#findRoot(java.net.URI)} instead.

        URI uri = file.toURI();

        for (CollocationQueryImplementation2 cqi : implementations2.allInstances()) {

            URI root = cqi.findRoot(uri);

            if (root != null) {

                return new File(root);

            }

        }

    /**

     * Find a root of a logical tree containing this file, if any.

     * @param file a file on disk

     * @return an ancestor directory which is the root of a logical tree,

     *         if any (else null)

     * @since 1.27

     */

    public static URI findRoot(URI file) {

        if (!file.equals(file.normalize())) {

            throw new IllegalArgumentException("Parameter file was not "+  // NOI18N

                "normalized. Was "+file+" instead of "+file.normalize());  // NOI18N

        }

        for (CollocationQueryImplementation2 cqi : implementations2.allInstances()) {

            URI root = cqi.findRoot(file);

            if (root != null) {

                return root;

            }

        }

        if ("file".equals(file.getScheme())) { // NOI18N

            File f = FileUtil.normalizeFile(new File(file));

            for (CollocationQueryImplementation cqi : implementations.allInstances()) {

                File root = cqi.findRoot(f);

                if (root != null) {

                    return root.toURI();

                }

            }

        }

        return null;

    }

import java.net.URI;

import java.net.URISyntaxException;

import java.net.URL;

import java.util.logging.Level;

import java.util.logging.Logger;

import org.netbeans.spi.queries.SharabilityQueryImplementation2;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileStateInvalidException;

    private static final Lookup.Result<SharabilityQueryImplementation2> implementations2 =

        Lookup.getDefault().lookupResult(SharabilityQueryImplementation2.class);

    private static final Logger LOG = Logger.getLogger(SharabilityQuery.class.getName());

     * @deprecated Use {@link org.netbeans.api.queries.SharabilityQuery.Sharability#UNKNOWN} instead.

     * @deprecated Use {@link org.netbeans.api.queries.SharabilityQuery.Sharability#SHARABLE} instead.

     * @deprecated Use {@link org.netbeans.api.queries.SharabilityQuery.Sharability#NOT_SHARABLE} instead.

     * @deprecated Use {@link org.netbeans.api.queries.SharabilityQuery.Sharability#MIXED} instead.

     * @deprecated Use {@link org.netbeans.api.queries.SharabilityQuery#getSharability(java.net.URI)} instead.

        URI uri = null;

        for (SharabilityQueryImplementation2 sqi : implementations2.allInstances()) {

            if (uri == null) {

                uri = file.toURI();

            }

            Sharability x = sqi.getSharability(uri);

            if (x != Sharability.UNKNOWN) {

                return x.ordinal();

            }

        }

    /**

     * Check whether an existing file is sharable.

     * @param uri a file or directory (may or may not already exist); should be normalized.

     * @return one of the constants in this class

     * @since 1.27

     */

    public static Sharability getSharability(URI uri) {

        Parameters.notNull("uri", uri);

        boolean asserts = false;

        assert asserts = true;

        if (asserts) {

            URI normUri = uri.normalize();

            if (!uri.equals(normUri)) {

                throw new IllegalArgumentException("Must pass a normalized URI: " + uri + " vs. " + normUri);

            }

        }

        for (SharabilityQueryImplementation2 sqi : implementations2.allInstances()) {

            Sharability x = sqi.getSharability(uri);

            if (x != Sharability.UNKNOWN) {

                return x;

            }

        }

        if ("file".equals(uri.getScheme())) { // NOI18N

            File file = FileUtil.normalizeFile(new File(uri));

            for (SharabilityQueryImplementation sqi : implementations.allInstances()) {

                int x = sqi.getSharability(file);

                if (x != UNKNOWN) {

                    return Sharability.values()[x];

                }

            }

        }

        return Sharability.UNKNOWN;

    }

    /**

     * Check whether an existing file is sharable.

     * @param fo a file or directory; should be normalized.

     * @return one of the constants in this class

     * @since 1.27

     */

    public static Sharability getSharability(FileObject fo) {

        try {

            return getSharability(fo.getURL().toURI());

        } catch (URISyntaxException ex) {

            LOG.log(Level.FINE, null, ex);

        } catch (FileStateInvalidException ex) {

            LOG.log(Level.FINE, null, ex);

        }

        return Sharability.UNKNOWN;

    }

 * @deprecated Use {@link org.netbeans.spi.queries.CollocationQueryImplementation2} instead.

/*

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

 *

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

 */

package org.netbeans.spi.queries;

import java.net.URI;

/**

 * A query which should typically be provided by a VCS to give information

 * about whether some files can be considered part of one logical directory tree.

 * <p>

 * This should be treated as a heuristic, useful when deciding whether to use

 * absolute or relative links between path locations.

 * </p>

 * <p>

 * The file names might refer to nonexistent files. A provider may or may not

 * be able to say anything useful about them in this case.

 * </p>

 * <p>

 * File names passed to this query will already have been normalized according to

 * the semantics of {@link org.openide.filesystems.FileUtil#normalizeFile}.

 * </p>

 * <p>

 * Threading note: implementors should avoid acquiring locks that might be held

 * by other threads. Generally treat this interface similarly to SPIs in

 * {@link org.openide.filesystems} with respect to threading semantics.

 * </p>

 * @see org.netbeans.api.queries.CollocationQuery

 * @since 1.27

 * @author Jesse Glick

 * @author Alexander Simon

 */

public interface CollocationQueryImplementation2 {

    /**

     * Check whether two files are logically part of one directory tree.

     * For example, if both files are stored in CVS, with the same server

     * (<code>CVSROOT</code>) they might be considered collocated.

     * If they are to be collocated their absolute paths must share a

     * prefix directory, i.e. they must be located in the same filesystem root.

     * If nothing is known about them, return false.

     * @param file1 one file

     * @param file2 another file

     * @return true if they are probably part of one logical tree

     */

    boolean areCollocated(URI file1, URI file2);

    /**

     * Find a root of a logical tree containing this file, if any.

     * The path of the root (if there is one) must be a prefix of the path of the file.

     * @param file a file on disk (must be an absolute URI)

     * @return an ancestor directory which is the root of a logical tree,

     *         if any (else null) (must be an absolute URI)

     */

    URI findRoot(URI file);

}

 * @since 1.27

 * @deprecated Use {@link org.netbeans.spi.queries.SharabilityQueryImplementation2} instead.

 * 

/*

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

 *

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

 */

package org.netbeans.spi.queries;

import java.net.URI;

import org.netbeans.api.queries.SharabilityQuery.Sharability;

/**

 * Determine whether files should be shared (for example in a VCS) or are intended

 * to be unshared.

 * <div class="nonnormative">

 * <p>

 * Could be implemented e.g. by project types which know that certain files or folders in

 * a project (e.g. <samp>src/</samp>) are intended for VCS sharing while others

 * (e.g. <samp>build/</samp>) are not.

 * </p>

 * <p>

 * Note that the Project API module registers a default implementation of this query

 * which delegates to the project which owns the queried file, if there is one.

 * This is more efficient than searching instances in global lookup, so use that

 * facility wherever possible.

 * </p>

 * </div>

 * <p>

 * Threading note: implementors should avoid acquiring locks that might be held

 * by other threads. Generally treat this interface similarly to SPIs in

 * {@link org.openide.filesystems} with respect to threading semantics.

 * </p>

 * @see org.netbeans.api.queries.SharabilityQuery

 * @see <a href="@org-netbeans-modules-project-ant@/org/netbeans/spi/project/support/ant/AntProjectHelper.html#createSharabilityQuery(java.lang.String[],%20java.lang.String[])"><code>AntProjectHelper.createSharabilityQuery(...)</code></a>

 * @author Jesse Glick

 * @author Alexander Simon

 * @since 1.27

 */

public interface SharabilityQueryImplementation2 {

    /**

     * Check whether a file or directory should be shared.

     * If it is, it ought to be committed to a VCS if the user is using one.

     * If it is not, it is either a disposable build product, or a per-user

     * private file which is important but should not be shared.

     * @param uri a normalized URI to check for sharability (may or may not yet exist).

     * @return one of the {@link org.netbeans.api.queries.SharabilityQuery.Sharability}'s constant

     */

    Sharability getSharability(URI uri);

}

/*

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

 *

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

 */

package org.netbeans.api.queries;

import java.io.File;

import java.io.IOException;

import java.net.URI;

import org.netbeans.junit.MockServices;

import org.netbeans.junit.NbTestCase;

import org.netbeans.spi.queries.CollocationQueryImplementation2;

/**

 *

 * @author Alexander Simon

 */

public class CollocationQuery2Test extends NbTestCase {

    public CollocationQuery2Test(String testMethod) {

        super (testMethod);

    }

    @Override

    public void setUp() throws IOException {

        MockServices.setServices(CollocationQuery2Test.CollocationQueryImplementation2Impl.class);

    }

    public void testAreCollocated() throws Exception {

        clearWorkDir();

        File base = getWorkDir();

        File proj1 = new File(base, "proj1");

        proj1.mkdirs();

        File proj3 = new File(proj1, "proj3");

        proj3.mkdirs();

        File proj2 = new File(base, "proj2");

        proj2.mkdirs();

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj1, proj3));

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj3.toURI()));

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj3, proj1));

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj3.toURI(), proj1.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1, proj2));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj2.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj2, proj1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj2.toURI(), proj1.toURI()));

        // folder does not exist:

        File proj4 = new File(base, "proj");

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1, proj4));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj4.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4, proj1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4.toURI(), proj1.toURI()));

        proj4.mkdirs();

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1, proj4));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj4.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4, proj1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4.toURI(), proj1.toURI()));

        // files do not exist:

        File file1 = new File(base, "file1.txt");

        File file2 = new File(base, "file1");

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file1, file2));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file1.toURI(), file2.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file2, file1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file2.toURI(), file1.toURI()));

        // passing the same parameter

        assertTrue("A file must be collocated with itself", CollocationQuery.areCollocated(proj1, proj1));

        assertTrue("A file must be collocated with itself", CollocationQuery.areCollocated(proj1.toURI(), proj1.toURI()));

    }

    public static class CollocationQueryImplementation2Impl implements CollocationQueryImplementation2 {

        @Override

        public boolean areCollocated(URI uri1, URI uri2) {

            if (uri1.equals(uri2)) {

                return true;

            }

            File file1 = new File(uri1);

            File file2 = new File(uri2);

            String f1 = file1.getPath();

            if ((file1.isDirectory() || !file1.exists()) && !f1.endsWith(File.separator)) {

                f1 += File.separatorChar;

            }

            String f2 = file2.getAbsolutePath();

            if ((file2.isDirectory() || !file2.exists()) && !f2.endsWith(File.separator)) {

                f2 += File.separatorChar;

            }

            return f1.startsWith(f2) || f2.startsWith(f1);

        }

        @Override

        public URI findRoot(URI file) {

            return null;

        }

    }

}

/*

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

 *

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

 */

package org.netbeans.api.queries;

import java.io.File;

import java.io.IOException;

import org.netbeans.junit.NbTestCase;

/**

 *

 * @author Alexander Simon

 */

public class CollocationQueryTest extends NbTestCase {

    public CollocationQueryTest(String testMethod) {

        super (testMethod);

    }

    @Override

    public void setUp() throws IOException {

    }

    public void testAreCollocated() throws Exception {

        clearWorkDir();

        File base = getWorkDir();

        File proj1 = new File(base, "proj1");

        proj1.mkdirs();

        File proj3 = new File(proj1, "proj3");

        proj3.mkdirs();

        File proj2 = new File(base, "proj2");

        proj2.mkdirs();

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj1, proj3));

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj3.toURI()));

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj3, proj1));

        assertTrue("Must be collocated", CollocationQuery.areCollocated(proj3.toURI(), proj1.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1, proj2));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj2.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj2, proj1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj2.toURI(), proj1.toURI()));

        // folder does not exist:

        File proj4 = new File(base, "proj");

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1, proj4));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj4.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4, proj1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4.toURI(), proj1.toURI()));

        proj4.mkdirs();

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1, proj4));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj1.toURI(), proj4.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4, proj1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(proj4.toURI(), proj1.toURI()));

        // files do not exist:

        File file1 = new File(base, "file1.txt");

        File file2 = new File(base, "file1");

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file1, file2));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file1.toURI(), file2.toURI()));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file2, file1));

        assertFalse("Cannot be collocated", CollocationQuery.areCollocated(file2.toURI(), file1.toURI()));

        // passing the same parameter

        assertTrue("A file must be collocated with itself", CollocationQuery.areCollocated(proj1, proj1));

        assertTrue("A file must be collocated with itself", CollocationQuery.areCollocated(proj1.toURI(), proj1.toURI()));

    }

}

/*

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

 *

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

 */

package org.netbeans.api.queries;

import java.io.File;

import java.io.IOException;

import java.net.URI;

import java.net.URISyntaxException;

import org.netbeans.api.queries.SharabilityQuery.Sharability;

import org.netbeans.junit.MockServices;

import org.netbeans.junit.NbTestCase;

import org.netbeans.spi.queries.SharabilityQueryImplementation;

import org.netbeans.spi.queries.SharabilityQueryImplementation2;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileUtil;

/**

 *

 * @author Alexander Simon

 */

public class SharabilityQueryTest extends NbTestCase {

    public SharabilityQueryTest(String testMethod) {

        super (testMethod);

    }

    @Override

    public void setUp() throws IOException {

        clearWorkDir();

        MockServices.setServices(SharabilityQueryImplementationImpl.class, SharabilityQueryImplementation2Impl.class);

    }

    public void testSharableBridge2Old() throws IOException {

        File file = new File("/home/user/aFile.sharable");

        int sharability = SharabilityQuery.getSharability(file);

        assertEquals(SharabilityQuery.SHARABLE, sharability);

        URI uri = file.toURI();

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.SHARABLE, sharability2);

        FileObject fo = FileUtil.toFileObject(getWorkDir()).createData("aFile", "sharable");

        assertEquals(sharability2, SharabilityQuery.getSharability(fo));

    }

    public void testSharableBridge2New() throws IOException {

        File file = new File("/home/user/aFile.sharable2");

        int sharability = SharabilityQuery.getSharability(file);

        assertEquals(SharabilityQuery.SHARABLE, sharability);

        URI uri = file.toURI();

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.SHARABLE, sharability2);

        FileObject fo = FileUtil.toFileObject(getWorkDir()).createData("aFile", "sharable2");

        assertEquals(sharability2, SharabilityQuery.getSharability(fo));

    }

    public void testNotSharableBridge2Old() throws IOException {

        File file = new File("/home/user/aFile.not_sharable");

        int sharability = SharabilityQuery.getSharability(file);

        assertEquals(SharabilityQuery.NOT_SHARABLE, sharability);

        URI uri = file.toURI();

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.NOT_SHARABLE, sharability2);

        FileObject fo = FileUtil.toFileObject(getWorkDir()).createData("aFile", "not_sharable");

        assertEquals(sharability2, SharabilityQuery.getSharability(fo));

    }

    public void testNotSharableBridge2New() throws IOException {

        File file = new File("/home/user/aFile.not_sharable2");

        int sharability = SharabilityQuery.getSharability(file);

        assertEquals(SharabilityQuery.NOT_SHARABLE, sharability);

        URI uri = file.toURI();

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.NOT_SHARABLE, sharability2);

        FileObject fo = FileUtil.toFileObject(getWorkDir()).createData("aFile", "not_sharable2");

        assertEquals(sharability2, SharabilityQuery.getSharability(fo));

    }

    public void testMixedBridge2Old() throws IOException {

        File file = new File("/home/user/aFile.mixed");

        int sharability = SharabilityQuery.getSharability(file);

        assertEquals(SharabilityQuery.MIXED, sharability);

        URI uri = file.toURI();

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.MIXED, sharability2);

        FileObject fo = FileUtil.toFileObject(getWorkDir()).createData("aFile", "mixed");

        assertEquals(sharability2, SharabilityQuery.getSharability(fo));

    }

    public void testMixedBridge2New() throws IOException {

        File file = new File("/home/user/aFile.mixed2");

        int sharability = SharabilityQuery.getSharability(file);

        assertEquals(SharabilityQuery.MIXED, sharability);

        URI uri = file.toURI();

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.MIXED, sharability2);

        FileObject fo = FileUtil.toFileObject(getWorkDir()).createData("aFile", "mixed2");

        assertEquals(sharability2, SharabilityQuery.getSharability(fo));

    }

    public void testUnknown() throws IOException {

        File file = new File("/home/user/aFile.txt");

        int sharability = SharabilityQuery.getSharability(file);

        assertEquals(SharabilityQuery.UNKNOWN, sharability);

        URI uri = file.toURI();

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.UNKNOWN, sharability2);

        FileObject fo = FileUtil.toFileObject(getWorkDir()).createData("aFile", "txt");

        assertEquals(sharability2, SharabilityQuery.getSharability(fo));

    }

    public void testNormalized() throws IOException {

        File file = new File("/home/user/../aFile.txt");

        Exception exception = null;

        try {

            SharabilityQuery.getSharability(file);

        } catch (IllegalArgumentException e) {

            exception = e;

        }

        assertNotNull(exception);

        URI uri = file.toURI();

        exception = null;

        try {

            SharabilityQuery.getSharability(uri);

        } catch (IllegalArgumentException e) {

            exception = e;

        }

        assertNotNull(exception);

    }

    public void testRfs() throws IOException, URISyntaxException {

        URI uri = new URI("rfs", "tester", "localhost", 22, "/home/tester/aFile.sharable", null, null);

        Sharability sharability = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.UNKNOWN, sharability);

        uri = new URI("rfs", "tester", "localhost", 22, "/home/tester/aFile.sharable2", null, null);

        Sharability sharability2 = SharabilityQuery.getSharability(uri);

        assertEquals(SharabilityQuery.Sharability.SHARABLE, sharability2);

    }

    public static class SharabilityQueryImplementationImpl implements SharabilityQueryImplementation {

        @Override

        public int getSharability(File file) {

            String path = file.getAbsolutePath();

            if (path.endsWith(".sharable")) {

                return SharabilityQuery.SHARABLE;

            } else if (path.endsWith(".not_sharable")) {

                return SharabilityQuery.NOT_SHARABLE;

            } else if (path.endsWith(".mixed")) {

                return SharabilityQuery.MIXED;

            }

            return SharabilityQuery.UNKNOWN;

        }

    }

    public static class SharabilityQueryImplementation2Impl implements SharabilityQueryImplementation2 {

        @Override

        public Sharability getSharability(URI uri) {

            String path = uri.getPath();

            if (path.endsWith(".sharable2")) {

                return SharabilityQuery.Sharability.SHARABLE;

            } else if (path.endsWith(".not_sharable2")) {

                return SharabilityQuery.Sharability.NOT_SHARABLE;

            } else if (path.endsWith(".mixed2")) {

                return SharabilityQuery.Sharability.MIXED;

            }

            return SharabilityQuery.Sharability.UNKNOWN;

        }

    }

}