1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.commons.vfs.operations;
18
19 import org.apache.commons.vfs.FileSystemException;
20
21 /***
22 * <p>
23 * A FileOperation is an object that brings an extra functions to a FileObject.
24 * The VFS provides the basic functionality to deal with FileObject's. Tha is
25 * create, delete, rename, copy, etc functions. However, if you are working with
26 * FileSystem and its files are, for example, under Version Control System (VCS)
27 * you might want to get an access to the versioning framework and to be able to
28 * manage your files regarding VCS (e.g. commit them, undate, get logs, etc.).
29 * Such type of extended functionality is provided by FileOperation.
30 * </p>
31 * <p>
32 * The FileOperation interface is a genetic interface that should not be
33 * implemented directly. It rather should be extended by other interfaces that
34 * provide some concrete functions.
35 * </p>
36 * <p>
37 * FileOperation is provided by
38 *
39 * @see FileOperationProvider Especially the FileOperationProvider is responsible
40 * for looking up and instantiating any concrete FileOperation.
41 * </p>
42 *
43 * @author Siarhei Baidun
44 * @since 0.1
45 */
46 public interface FileOperation
47 {
48
49 /***
50 * Performs necessary actions that are related to the concrete
51 * implementation of a FileOperation.
52 *
53 * @throws FileSystemException
54 */
55 void process() throws FileSystemException;
56 }