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.configuration2.io;
18
19 import java.net.URL;
20
21 /**
22 * <p>
23 * A specialized implementation of {@code FileLocationStrategy} which checks whether a passed in {@link FileLocator}
24 * already has a defined URL.
25 * </p>
26 * <p>
27 * {@code FileLocator} objects that have a URL already reference a file in an unambiguous way. Therefore, this strategy
28 * just returns the URL of the passed in {@code FileLocator}. It can be used as a first step of the file resolving
29 * process. If it fails, more sophisticated attempts for resolving the file can be made.
30 * </p>
31 *
32 * @since 2.0
33 */
34 public class ProvidedURLLocationStrategy implements FileLocationStrategy {
35 /**
36 * {@inheritDoc} This implementation just returns the URL stored in the given {@code FileLocator}.
37 */
38 @Override
39 public URL locate(final FileSystem fileSystem, final FileLocator locator) {
40 return locator.getSourceURL();
41 }
42 }