View Javadoc

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