@@ -, +, @@ - first variant API --- a/queries/src/org/netbeans/api/queries/SharabilityQuery.java +++ a/queries/src/org/netbeans/api/queries/SharabilityQuery.java @@ -45,8 +45,13 @@ package org.netbeans.api.queries; import java.io.File; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; import org.netbeans.spi.queries.SharabilityQueryImplementation; +import org.netbeans.spi.queries.SharabilityQueryImplementation2; import org.openide.filesystems.FileUtil; +import org.openide.util.Exceptions; import org.openide.util.Lookup; import org.openide.util.Parameters; import org.openide.util.Utilities; @@ -127,4 +132,54 @@ return UNKNOWN; } + /** + * Check whether an existing file is sharable. + * @param url a file or directory (may or may not already exist); should be normalized. + * @return one of the constants in this class + */ + public static int getSharability(URL url) { + Parameters.notNull("file", url); + boolean asserts = false; + assert asserts = true; + if (asserts && !Utilities.isMac()) { + try { + URI uri = new URI(url.toExternalForm()); + URI normUri = uri.normalize(); + if (!uri.equals(uri)) { + throw new IllegalArgumentException("Must pass a normalized file: " + uri + " vs. " + normUri); + } + } catch (URISyntaxException ex) { + Exceptions.printStackTrace(ex); + } + } + File file = null; + for (SharabilityQueryImplementation sqi : implementations.allInstances()) { + if (sqi instanceof SharabilityQueryImplementation2) { + int x = ((SharabilityQueryImplementation2)sqi).getSharability(url); + if (x != UNKNOWN) { + return x; + } + } else { + if (file == null) { + if ("file".equals(url.getProtocol())) { + try { + URI uri = new URI(url.toExternalForm()); + file = new File(uri); + } catch (URISyntaxException ex) { + Exceptions.printStackTrace(ex); + break; + } + } + } + if (file != null) { + int x = sqi.getSharability(file); + if (x != UNKNOWN) { + return x; + } + } + } + } + return UNKNOWN; + } + } --- a/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation2.java +++ a/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation2.java @@ -0,0 +1,83 @@ +/* + * 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.URL; + +/** + * Determine whether files should be shared (for example in a VCS) or are intended + * to be unshared. + *
+ *

+ * Could be implemented e.g. by project types which know that certain files or folders in + * a project (e.g. src/) are intended for VCS sharing while others + * (e.g. build/) are not. + *

+ *

+ * 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. + *

+ *
+ *

+ * 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. + *

+ * @see org.netbeans.api.queries.SharabilityQuery + * @see AntProjectHelper.createSharabilityQuery(...) + * @author Jesse Glick + * @author Alexander Simon + */ +public interface SharabilityQueryImplementation2 extends SharabilityQueryImplementation { + + /** + * 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 url a normalized URL to check for sharability (may or may not yet exist). + * @return one of {@link org.netbeans.api.queries.SharabilityQuery}'s constants + */ + int getSharability(URL url); +}