More javadoc about identity FileObjectGetLookup209231
authorJaroslav Tulach <jtulach@netbeans.org>
Tue, 21 Aug 2012 13:11:52 +0200
branchFileObjectGetLookup209231
changeset 23658275dae001a3b5
parent 236581 c8e5362dcbe4
child 236583 03c4d8750398
More javadoc about identity
openide.filesystems/src/org/openide/filesystems/FileObject.java
     1.1 --- a/openide.filesystems/src/org/openide/filesystems/FileObject.java	Mon Aug 20 15:05:59 2012 +0200
     1.2 +++ b/openide.filesystems/src/org/openide/filesystems/FileObject.java	Tue Aug 21 13:11:52 2012 +0200
     1.3 @@ -400,13 +400,22 @@
     1.4       * {@link #move(org.openide.filesystems.FileLock, org.openide.filesystems.FileObject, java.lang.String, java.lang.String) move operation}
     1.5       * - the resulting {@link FileObject} after successful <em>move</em>
     1.6       * will share the same {@link Lookup} as the original {@link FileObject}.
     1.7 +     * That is why one can put <code>fileObject.getLookup()</code> into 
     1.8 +     * {@link java.util.IdentityHashMap}{@code <Lookup,Anything>} and cache 
     1.9 +     * <code>Anything</code> regardless the actual location of (moved) file.
    1.10       * 
    1.11       * <p class="nonnormative">
    1.12       * Inside of NetBeans Platform application the content of this lookup is usually
    1.13       * identical to the one provided by the 
    1.14       * <code><a href="@org-openide-loaders@/org/openide/loaders/DataObject.html">DataObject</a>.find(this).getLookup()</code>.
    1.15 -     * To get this behavior include the <code>org.netbeans.modules.settings</code> 
    1.16 -     * module in your system.
    1.17 +     * This functionality is provided by the <code>org.netbeans.modules.settings</code> 
    1.18 +     * module. 
    1.19 +     * <code><a href="@org-openide-loaders@/org/openide/loaders/DataObject.html">DataObject</a>.move</code>
    1.20 +     * operation preserves the object's identity, and to mimic the same behavior 
    1.21 +     * without reference to 
    1.22 +     * <a href="@org-openide-loaders@/org/openide/loaders/DataObject.html">DataObject</a>
    1.23 +     * the behavior of {@link FileObject#getLookup() FileObject.getLookup()} has 
    1.24 +     * been modelled.
    1.25       * </p>
    1.26       * 
    1.27       * @return lookup providing logical interfaces additionally describing the