← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to openide/fs/src/org/openide/filesystems/FileChangeListener.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
openide/fs/src/org/openide/filesystems/FileChangeListener.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "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.openide.filesystems;
 
43
 
 
44
import java.util.EventListener;
 
45
 
 
46
/** Listener for changes in <code>FileObject</code>s. Can be attached to any <code>FileObject</code>.
 
47
* <P>
 
48
* When attached to a file it listens for file changes (due to saving from inside NetBeans) and
 
49
* for deletes and renames.
 
50
* <P>
 
51
* When attached to a folder it listens for all actions taken on this folder.
 
52
* These include any modifications of data files or folders,
 
53
* and creation of new data files or folders.
 
54
*
 
55
* @see FileObject#addFileChangeListener
 
56
*
 
57
* @author Jaroslav Tulach, Petr Hamernik
 
58
*/
 
59
public interface FileChangeListener extends EventListener {
 
60
    /** Fired when a new folder is created. This action can only be
 
61
     * listened to in folders containing the created folder up to the root of
 
62
     * filesystem.
 
63
      *
 
64
     * @param fe the event describing context where action has taken place
 
65
     */
 
66
    public abstract void fileFolderCreated(FileEvent fe);
 
67
 
 
68
    /** Fired when a new file is created. This action can only be
 
69
    * listened in folders containing the created file up to the root of
 
70
    * filesystem.
 
71
    *
 
72
    * @param fe the event describing context where action has taken place
 
73
    */
 
74
    public abstract void fileDataCreated(FileEvent fe);
 
75
 
 
76
    /** Fired when a file is changed.
 
77
    * @param fe the event describing context where action has taken place
 
78
    */
 
79
    public abstract void fileChanged(FileEvent fe);
 
80
 
 
81
    /** Fired when a file is deleted.
 
82
    * @param fe the event describing context where action has taken place
 
83
    */
 
84
    public abstract void fileDeleted(FileEvent fe);
 
85
 
 
86
    /** Fired when a file is renamed.
 
87
    * @param fe the event describing context where action has taken place
 
88
    *           and the original name and extension.
 
89
    */
 
90
    public abstract void fileRenamed(FileRenameEvent fe);
 
91
 
 
92
    /** Fired when a file attribute is changed.
 
93
    * @param fe the event describing context where action has taken place,
 
94
    *           the name of attribute and the old and new values.
 
95
    */
 
96
    public abstract void fileAttributeChanged(FileAttributeEvent fe);
 
97
}