001/*
002 * Copyright 2002-2020 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.core.io.support;
018
019import java.io.IOException;
020
021import org.springframework.core.env.PropertySource;
022import org.springframework.lang.Nullable;
023
024/**
025 * Strategy interface for creating resource-based {@link PropertySource} wrappers.
026 *
027 * @author Juergen Hoeller
028 * @since 4.3
029 * @see DefaultPropertySourceFactory
030 */
031public interface PropertySourceFactory {
032
033        /**
034         * Create a {@link PropertySource} that wraps the given resource.
035         * @param name the name of the property source
036         * (can be {@code null} in which case the factory implementation
037         * will have to generate a name based on the given resource)
038         * @param resource the resource (potentially encoded) to wrap
039         * @return the new {@link PropertySource} (never {@code null})
040         * @throws IOException if resource resolution failed
041         */
042        PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException;
043
044}