KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > vfs > provider > FileReplicator


1 /*
2  * Copyright 2002-2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.commons.vfs.provider;
17
18 import org.apache.commons.vfs.FileObject;
19 import org.apache.commons.vfs.FileSelector;
20 import org.apache.commons.vfs.FileSystemException;
21
22 import java.io.File JavaDoc;
23
24 /**
25  * Responsible for making local replicas of files.
26  * <p/>
27  * <p>A file replicator may also implement {@link VfsComponent}.
28  *
29  * @author <a HREF="mailto:adammurdoch@apache.org">Adam Murdoch</a>
30  */
31 public interface FileReplicator
32 {
33     /**
34      * Creates a local copy of the file, and all its descendents.
35      *
36      * @param srcFile The file to copy.
37      * @param selector Selects the files to copy.
38      * @return The local copy of the source file.
39      * @throws FileSystemException If the source files does not exist, or on error copying.
40      */
41     File JavaDoc replicateFile(FileObject srcFile, FileSelector selector)
42         throws FileSystemException;
43 }
44
Popular Tags