    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
    021import org.apache.commons.lang3.StringUtils;
    022
    023/**
    024 * <p>
    025 * A specialized {@code FileLocationStrategy} implementation which searches for
    026 * files on the class path.
    027 * </p>
    028 * <p>
    029 * This strategy implementation ignores the URL and the base path components of
    030 * the passed in {@link FileLocator}. It tries to look up the file name on both
    031 * the class path and the system class path.
    032 * </p>
    033 *
    034 * @version $Id: ClasspathLocationStrategy.java 1842194 2018-09-27 22:24:23Z ggregory $
    035 * @since 2.0
    036 */
    037public class ClasspathLocationStrategy implements FileLocationStrategy
    038{
    039    /**
    040     * {@inheritDoc} This implementation looks up the locator's file name as a
    041     * resource on the class path.
    042     */
    043    @Override
    044    public URL locate(final FileSystem fileSystem, final FileLocator locator)
    045    {
    046        return StringUtils.isEmpty(locator.getFileName()) ? null
    047                : FileLocatorUtils.locateFromClasspath(locator.getFileName());
    048    }
    049}