01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.spi.java.classpath;
43:
44: import java.net.URL;
45:
46: /**
47: * SPI interface for a classpath entry which can include or exclude particular files.
48: * @author Jesse Glick
49: * @see "issue #49026"
50: * @since org.netbeans.api.java/1 1.13
51: */
52: public interface FilteringPathResourceImplementation extends
53: PathResourceImplementation {
54:
55: /**
56: * Property name to fire in case {@link #includes} would change.
57: * (The old and new value should be left null.)
58: * <p>
59: * <strong>Special usage note:</strong>
60: * If multiple {@link FilteringPathResourceImplementation}s inside a single
61: * {@link ClassPathImplementation} fire changes in this pseudo-property in
62: * succession, all using the same non-null {@link java.beans.PropertyChangeEvent#setPropagationId},
63: * {@link org.netbeans.api.java.classpath.ClassPath#PROP_INCLUDES} will be fired just once. This can be used
64: * to prevent "event storms" from triggering excessive Java source root rescanning.
65: */
66: String PROP_INCLUDES = "includes"; // NOI18N
67:
68: /**
69: * Determines whether a given resource is included in the classpath or not.
70: * @param root one of the roots given by {@link #getRoots} (else may throw {@link IllegalArgumentException})
71: * @param resource a relative resource path within that root; may refer to a file or slash-terminated folder; the empty string refers to the root itself
72: * @return true if included (or, in the case of a folder, at least partially included); false if excluded
73: */
74: boolean includes(URL root, String resource);
75:
76: }
|