001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.provider;
018
019import java.io.File;
020
021import org.apache.commons.vfs2.FileObject;
022import org.apache.commons.vfs2.FileSystemException;
023
024/**
025 * A file provider which handles local files.
026 */
027public interface LocalFileProvider extends FileProvider {
028
029    /**
030     * Converts from java.io.File to FileObject.
031     *
032     * @param file The File for the file.
033     * @return The FileObject for the file.
034     * @throws FileSystemException if an error occurs.
035     */
036    FileObject findLocalFile(File file) throws FileSystemException;
037
038    /**
039     * Finds a local file, from its local name.
040     *
041     * @param name The name of the file to locate.
042     * @return The FileObject for the file.
043     * @throws FileSystemException if an error occurs.
044     */
045    FileObject findLocalFile(String name) throws FileSystemException;
046
047    /**
048     * Determines if a name is an absolute file name.
049     * <p>
050     * TODO - Move this to a general file name parser interface.
051     * </p>
052     *
053     * @param name The name to test.
054     * @return true if the name is absolute.
055     */
056    boolean isAbsoluteLocalName(String name);
057}