Java Doc for SourcesHelper.java in  » IDE-Netbeans » project.ant » org » netbeans » spi » project » support » ant » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Useful for project type providers which have external paths holding build products.

Useful for project type providers which have external paths holding build products.

If an include or exclude string is given as null, then it is skipped.

All principal source roots are listed as Sources.TYPE_GENERIC unless they are inside the project directory.

Only roots added by SourcesHelper.addPrincipalSourceRoot and SourcesHelper.addNonSourceRoot are considered.

Useful for project type providers which have external paths holding build products. These should not appear in Sources , yet it may be useful for FileOwnerQuery to know the owning project (for example, in order for a project-specific SourceForBinaryQueryImplementation to work).

Useful for project type providers which have external paths holding build products. These should not appear in Sources , yet it may be useful for FileOwnerQuery to know the owning project (for example, in order for a project-specific SourceForBinaryQueryImplementation to work).

If the actual value of the location is inside the project directory, this is simply ignored; so it safe to configure principal source roots for any source directory which might be set to use an external path, even if the common location is internal.

If an include or exclude string is given as null, then it is skipped. A non-null value is evaluated and then treated as a comma- or space-separated pattern list, as detailed in the Javadoc for PathMatcher . (As a special convenience, a value consisting solely of an Ant property reference which cannot be evaluated, e.g. ${undefined}, is treated like null.) SourceGroup.contains will then reflect the includes and excludes for files, but note that the semantics of that method requires that a folder be "contained" in case any folder or file beneath it is contained, and in particular the root folder is always contained.

All principal source roots are listed as Sources.TYPE_GENERIC unless they are inside the project directory. The project directory itself is also listed (with a display name according to ProjectUtils.getInformation ), unless it is contained by an explicit principal source root (i.e. ancestor directory). Principal source roots should never overlap; if two configured principal source roots are determined to have the same root folder, the first configured root takes precedence (which only matters in regard to the display name); if one root folder is contained within another, the broader root folder subsumes the narrower one so only the broader root is listed.

Other source groups are listed according to the named typed source roots. There is no check performed that these do not overlap (though a project type provider should for UI reasons avoid this situation).

Any source roots which do not exist on disk are ignored, as if they had not been configured at all. Currently it is not defined when this existence check is performed (e.g. when this method is called, when the source root is first accessed, periodically, etc.), so project type providers are generally encouraged to make sure all desired source folders exist before calling this method, if creating a new project.

Source groups are created according to the semantics described in org.netbeans.spi.project.support.GenericSources.group . They are listed in the order they were configured (for those roots that are actually used as groups).

You may call this method inside the project's constructor, but Sources.getSourceGroups may not be called within the constructor, as it requires the actual project object to exist and be registered in ProjectManager .

Only roots added by SourcesHelper.addPrincipalSourceRoot and SourcesHelper.addNonSourceRoot are considered. They are registered if (and only if) they in fact fall outside of the project directory, and of course only if the folders really exist on disk. Currently it is not defined when this file existence check is done (e.g. when this method is first called, or periodically) or whether folders which are created subsequently will be registered, so project type providers are encouraged to create all desired external roots before calling this method.

If the actual value of the location changes (due to changes being fired from the property evaluator), roots which were previously internal and are now external will be registered, and roots which were previously external and are now internal will be unregistered. The (un-)registration will be done using the same algorithm as was used initially.

If an explicit include list is configured for a principal source root, only those subfolders which are included (or folders directly containing included files) will be registered. Note that the source root, or an included subfolder, will be registered even if it contains excluded files or folders beneath it.

Calling this method causes the helper object to hold strong references to the current external roots, which helps a project satisfy the requirements of FileOwnerQuery.EXTERNAL_ALGORITHM_TRANSIENT .

You may not call this method inside the project's constructor, as it requires the actual project to exist and be registered in ProjectManager . Typically you would use org.openide.util.Mutex.postWriteRequest to run it later, if you were creating the helper in your constructor, since the project construction normally occurs in read access.