#157458: Adding javadoc warning about recursive/non-recursive behaviour
authorJaroslav Tulach <jtulach@netbeans.org>
Sun, 15 Feb 2009 11:31:37 +0100
changeset 51297a5e046815f
parent 505 018bbeca3cd3
child 513 109b6b62c758
child 514 ace24c8ed1ad
#157458: Adding javadoc warning about recursive/non-recursive behaviour
openide.util/src/org/openide/util/lookup/Lookups.java
     1.1 --- a/openide.util/src/org/openide/util/lookup/Lookups.java	Fri Feb 06 11:55:38 2009 +0100
     1.2 +++ b/openide.util/src/org/openide/util/lookup/Lookups.java	Sun Feb 15 11:31:37 2009 +0100
     1.3 @@ -183,10 +183,21 @@
     1.4       * <p>It is expected that each <q>named</q> lookup
     1.5       * will contain a superset of what would be created by:
     1.6       * <code>{@linkplain #metaInfServices(ClassLoader,String) metaInfServices}(theRightLoader, "META-INF/namedservices/" + path + "/")</code>
     1.7 -     * <p>However various environments can add their own
     1.8 -     * extensions to its content. For example when running inside NetBeans Runtime
     1.9 -     * Container, the content of system file system under the given
    1.10 -     * <code>path</code> is also present in the returned lookup.
    1.11 +     *
    1.12 +     * <p class="nonnormative">Various environments can add their own
    1.13 +     * extensions to its content. As such
    1.14 +     * {@link Lookups#forPath(java.lang.String)} can combine lookups
    1.15 +     * from several sources. In current NetBeans Runtime Container, two lookups are used:
    1.16 +     * </p>
    1.17 +     * <ul class="nonnormative">
    1.18 +     * <li><code>Lookups.metaInfServices("META-INF/namedservices/" + path)</code></li>
    1.19 +     * <li><code>org.openide.loaders.FolderLookup(path)</code></li>
    1.20 +     * </ul>
    1.21 +     * <p class="nonnormative">
    1.22 +     * Please note that these lookups differ in the way they inspect sub-folders.
    1.23 +     * The first lookup just returns instances from the given path, ignoring
    1.24 +     * sub-folders, the second one retrieves instances from the whole sub-tree.
    1.25 +     * </p>
    1.26       * <p>
    1.27       * Read more about the <a href="../doc-files/api.html#folderlookup">usage of this method</a>.
    1.28       *