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 * https://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 import org.apache.commons.lang3.StringUtils;
22
23 /**
24 * <p>
25 * A specialized {@code FileLocationStrategy} implementation which searches for files on the class path.
26 * </p>
27 * <p>
28 * This strategy implementation ignores the URL and the base path components of the passed in {@link FileLocator}. It
29 * tries to look up the file name on both the class path and the system class path.
30 * </p>
31 *
32 * @since 2.0
33 */
34 public class ClasspathLocationStrategy implements FileLocationStrategy {
35
36 /**
37 * Constructs a new instance.
38 */
39 public ClasspathLocationStrategy() {
40 // empty
41 }
42
43 /**
44 * {@inheritDoc} This implementation looks up the locator's file name as a resource on the class path.
45 */
46 @Override
47 public URL locate(final FileSystem fileSystem, final FileLocator locator) {
48 return StringUtils.isEmpty(locator.getFileName()) ? null : FileLocatorUtils.getClasspathResource(locator.getFileName());
49 }
50 }