001/*
002 * Copyright 2002-2017 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.context.support;
018
019import org.springframework.context.EmbeddedValueResolverAware;
020import org.springframework.lang.Nullable;
021import org.springframework.util.StringValueResolver;
022
023/**
024 * Convenient base class for components with a need for embedded value resolution
025 * (i.e. {@link org.springframework.context.EmbeddedValueResolverAware} consumers).
026 *
027 * @author Juergen Hoeller
028 * @since 4.1
029 */
030public class EmbeddedValueResolutionSupport implements EmbeddedValueResolverAware {
031
032        @Nullable
033        private StringValueResolver embeddedValueResolver;
034
035
036        @Override
037        public void setEmbeddedValueResolver(StringValueResolver resolver) {
038                this.embeddedValueResolver = resolver;
039        }
040
041        /**
042         * Resolve the given embedded value through this instance's {@link StringValueResolver}.
043         * @param value the value to resolve
044         * @return the resolved value, or always the original value if no resolver is available
045         * @see #setEmbeddedValueResolver
046         */
047        @Nullable
048        protected String resolveEmbeddedValue(String value) {
049                return (this.embeddedValueResolver != null ? this.embeddedValueResolver.resolveStringValue(value) : value);
050        }
051
052
053}