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.configuration2.io;
018
019import java.net.URL;
020
021/**
022 * <p>
023 * A specialized implementation of {@code FileLocationStrategy} which uses the
024 * passed in {@link FileSystem} to locate a file.
025 * </p>
026 * <p>
027 * This strategy implementation ignores the URL of the passed in
028 * {@link FileLocator} and operates on its base path and file name. These
029 * properties are passed to the {@code locateFromURL()} method of
030 * {@code FileSystem}. So the burden of resolving the file is delegated to the
031 * {@code FileSystem}.
032 * </p>
033 *
034 * @since 2.0
035 */
036public class FileSystemLocationStrategy implements FileLocationStrategy
037{
038    /**
039     * {@inheritDoc} This implementation delegates to the {@code FileSystem}.
040     */
041    @Override
042    public URL locate(final FileSystem fileSystem, final FileLocator locator)
043    {
044        return fileSystem.locateFromURL(locator.getBasePath(),
045                locator.getFileName());
046    }
047}