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.vfs2.provider;
18  
19  import java.io.File;
20  
21  import org.apache.commons.vfs2.FileObject;
22  import org.apache.commons.vfs2.FileSystemException;
23  
24  /**
25   * A file provider which handles local files.
26   */
27  public interface LocalFileProvider extends FileProvider {
28  
29      /**
30       * Determines if a name is an absolute file name.
31       * <p>
32       * TODO - Move this to a general file name parser interface.
33       * </p>
34       *
35       * @param name The name to test.
36       * @return true if the name is absolute.
37       */
38      boolean isAbsoluteLocalName(final String name);
39  
40      /**
41       * Finds a local file, from its local name.
42       *
43       * @param name The name of the file to locate.
44       * @return The FileObject for the file.
45       * @throws FileSystemException if an error occurs.
46       */
47      FileObject findLocalFile(final String name) throws FileSystemException;
48  
49      /**
50       * Converts from java.io.File to FileObject.
51       *
52       * @param file The File for the file.
53       * @return The FileObject for the file.
54       * @throws FileSystemException if an error occurs.
55       */
56      FileObject findLocalFile(final File file) throws FileSystemException;
57  }