001/*
002 * Copyright 2002-2012 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.beans.factory.parsing;
018
019import org.springframework.core.io.Resource;
020import org.springframework.lang.Nullable;
021
022/**
023 * Simple {@link SourceExtractor} implementation that just passes
024 * the candidate source metadata object through for attachment.
025 *
026 * <p>Using this implementation means that tools will get raw access to the
027 * underlying configuration source metadata provided by the tool.
028 *
029 * <p>This implementation <strong>should not</strong> be used in a production
030 * application since it is likely to keep too much metadata in memory
031 * (unnecessarily).
032 *
033 * @author Rob Harrop
034 * @since 2.0
035 */
036public class PassThroughSourceExtractor implements SourceExtractor {
037
038        /**
039         * Simply returns the supplied {@code sourceCandidate} as-is.
040         * @param sourceCandidate the source metadata
041         * @return the supplied {@code sourceCandidate}
042         */
043        @Override
044        public Object extractSource(Object sourceCandidate, @Nullable Resource definingResource) {
045                return sourceCandidate;
046        }
047
048}