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: package org.netbeans.spi.java.queries;
42:
43: import org.openide.filesystems.FileObject;
44:
45: /**
46: * Permits providers to mark certain Java packages as being inaccessible to
47: * outside code despite possibly containing public classes.
48: * <p>
49: * A default implementation is registered by the
50: * <code>org.netbeans.modules.java.project</code> module which looks up the
51: * project corresponding to the file (if any) and checks whether that
52: * project has an implementation of this interface in its lookup. If so, it
53: * delegates to that implementation. Therefore it is not generally necessary
54: * for a project type provider to register its own global implementation of
55: * this query, if it depends on the Java Project module and uses this style.
56: * </p>
57: * @see org.netbeans.api.java.queries.AccessibilityQuery
58: * @see org.netbeans.api.queries.FileOwnerQuery
59: * @see org.netbeans.api.project.Project#getLookup
60: * @author Jesse Glick
61: * @since org.netbeans.api.java/1 1.4
62: */
63: public interface AccessibilityQueryImplementation {
64:
65: /**
66: * Checks whether a given Java package (folder of source files)
67: * is intended to be publicly accessed by code residing in other
68: * compilation units.
69: * @param pkg a Java source package
70: * @return true if it is definitely intended for public access, false if it
71: * is definitely not, or null if nothing is known about it
72: */
73: public Boolean isPubliclyAccessible(FileObject pkg);
74:
75: }
|