    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 *     https://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 passed in {@link FileSystem} to locate a
    024 * file.
    025 * </p>
    026 * <p>
    027 * This strategy implementation ignores the URL of the passed in {@link FileLocator} and operates on its base path and
    028 * file name. These properties are passed to the {@code locateFromURL()} method of {@code FileSystem}. So the burden of
    029 * resolving the file is delegated to the {@code FileSystem}.
    030 * </p>
    031 *
    032 * @since 2.0
    033 */
    034public class FileSystemLocationStrategy implements FileLocationStrategy {
    035
    036    /**
    037     * A singleton instance of this strategy.
    038     */
    039    static final FileSystemLocationStrategy INSTANCE = new FileSystemLocationStrategy();
    040
    041    /**
    042     * Constructs a new instance.
    043     */
    044    public FileSystemLocationStrategy() {
    045        // empty
    046    }
    047
    048    /**
    049     * {@inheritDoc} This implementation delegates to the {@code FileSystem}.
    050     */
    051    @Override
    052    public URL locate(final FileSystem fileSystem, final FileLocator locator) {
    053        return fileSystem.locateFromURL(locator.getBasePath(), locator.getFileName());
    054    }
    055}