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 checks
024 * whether a passed in {@link FileLocator} already has a defined URL.
025 * </p>
026 * <p>
027 * {@code FileLocator} objects that have a URL already reference a file in an
028 * unambiguous way. Therefore, this strategy just returns the URL of the passed
029 * in {@code FileLocator}. It can be used as a first step of the file resolving
030 * process. If it fails, more sophisticated attempts for resolving the file can
031 * be made.
032 * </p>
033 *
034 * @since 2.0
035 */
036public class ProvidedURLLocationStrategy implements FileLocationStrategy
037{
038    /**
039     * {@inheritDoc} This implementation just returns the URL stored in the
040     * given {@code FileLocator}.
041     */
042    @Override
043    public URL locate(final FileSystem fileSystem, final FileLocator locator)
044    {
045        return locator.getSourceURL();
046    }
047}