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.io.File;
20 import java.net.URL;
21
22 import org.apache.commons.lang3.StringUtils;
23
24 /**
25 * <p>
26 * A specialized implementation of {@code FileLocationStrategy} which checks whether the provided file name is already
27 * an absolute file name.
28 * </p>
29 * <p>
30 * This strategy ignores the URL and the base path stored in the passed in {@link FileLocator}. It is only triggered by
31 * absolute names in the locator's {@code fileName} component.
32 * </p>
33 *
34 * @since 2.0
35 */
36 public class AbsoluteNameLocationStrategy implements FileLocationStrategy {
37 /**
38 * {@inheritDoc} This implementation constructs a {@code File} object from the locator's file name (if defined). If this
39 * results in an absolute file name pointing to an existing file, the corresponding URL is returned.
40 */
41 @Override
42 public URL locate(final FileSystem fileSystem, final FileLocator locator) {
43 if (StringUtils.isNotEmpty(locator.getFileName())) {
44 final File file = new File(locator.getFileName());
45 if (file.isAbsolute() && file.exists()) {
46 return FileLocatorUtils.convertFileToURL(file);
47 }
48 }
49
50 return null;
51 }
52 }