KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > fileinfo > NonRecursiveFolder


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.fileinfo;
21
22 import org.openide.filesystems.FileObject;
23
24 /**
25  * Marker interface for representation of a folder without subfolders.
26  * When an implementation of this interface is contained in the
27  * lookup of a node, actions on that node should not process the subfolders
28  * of this folder.
29  * It is permitted for a Node to have both the {@link org.openide.loaders.DataFolder}
30  * and NonRecursiveFolder in its lookup. In this case the {@link NonRecursiveFolder#getFolder} has to
31  * return the same {@link FileObject} as the {@link org.openide.loaders.DataFolder#getPrimaryFile} method.
32  * Any action which checks for the NonRecursiveFolder at all must prefer it to
33  * the DataFolder since it is considered to be more specific information.
34  *
35  * @author Martin Entlicher
36  * @since 1.4
37  */
38 public interface NonRecursiveFolder {
39     
40     /**
41      * Get the folder file object, which represents the non-recursive folder.
42      * Only direct children should be processed, no sub-folders.
43      * @return The file object that represents non-recursive folder.
44      */
45     FileObject getFolder();
46     
47 }
48
Popular Tags