org.netbeans.spi.java.queries

Interface AccessibilityQueryImplementation2

public interface AccessibilityQueryImplementation2

Permits providers to mark certain Java packages as being inaccessible to outside code despite possibly containing public classes.

A default implementation is registered by the org.netbeans.modules.java.project module which looks up the project corresponding to the file (if any) and checks whether that project has an implementation of this interface in its lookup. If so, it delegates to that implementation. Therefore it is not generally necessary for a project type provider to register its own global implementation of this query, if it depends on the Java Project module and uses this style.

Since:

1.64

See Also:

AccessibilityQuery, FileOwnerQuery, Project#getLookup

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AccessibilityQueryImplementation2.Result Result of finding accessibility of a Java package, encapsulating the answer as well as the ability to listen to it.

Method Summary

Modifier and Type	Method and Description
AccessibilityQueryImplementation2.Result	isPubliclyAccessible(FileObject pkg) Checks whether a given Java package (folder of source files) is intended to be publicly accessed by code residing in other compilation units.

Method Detail

isPubliclyAccessible

@CheckForNull
AccessibilityQueryImplementation2.Result isPubliclyAccessible(@NonNull
                                                                            FileObject pkg)

Checks whether a given Java package (folder of source files) is intended to be publicly accessed by code residing in other compilation units.

Parameters:

pkg - a Java source package

Returns:

the AccessibilityQueryImplementation2.Result object encapsulating the accessibility of the Java package.