01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.api.fileinfo;
43:
44: import org.openide.filesystems.FileObject;
45:
46: /**
47: * Marker interface for representation of a folder without subfolders.
48: * When an implementation of this interface is contained in the
49: * lookup of a node, actions on that node should not process the subfolders
50: * of this folder.
51: * It is permitted for a Node to have both the {@link org.openide.loaders.DataFolder}
52: * and NonRecursiveFolder in its lookup. In this case the {@link NonRecursiveFolder#getFolder} has to
53: * return the same {@link FileObject} as the {@link org.openide.loaders.DataFolder#getPrimaryFile} method.
54: * Any action which checks for the NonRecursiveFolder at all must prefer it to
55: * the DataFolder since it is considered to be more specific information.
56: *
57: * @author Martin Entlicher
58: * @since 1.4
59: */
60: public interface NonRecursiveFolder {
61:
62: /**
63: * Get the folder file object, which represents the non-recursive folder.
64: * Only direct children should be processed, no sub-folders.
65: * @return The file object that represents non-recursive folder.
66: */
67: FileObject getFolder();
68:
69: }
|