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.FileSystemException;
21  
22  import java.io.File;
23  
24  /***
25   * A file provider which handles local files.
26   *
27   * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
28   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
29   */
30  public interface LocalFileProvider
31      extends FileProvider
32  {
33      /***
34       * Determines if a name is an absolute file name.
35       *
36       * @param name The name to test.
37       * @todo Move this to a general file name parser interface.
38       */
39      boolean isAbsoluteLocalName(final String name);
40  
41      /***
42       * Finds a local file, from its local name.
43       */
44      FileObject findLocalFile(final String name)
45          throws FileSystemException;
46  
47      /***
48       * Converts from java.io.File to FileObject.
49       */
50      FileObject findLocalFile(final File file)
51          throws FileSystemException;
52  }