001/*
002 * Copyright 2012-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 *      http://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.boot.context.properties;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025/**
026 * Indicates that a getter in a {@link ConfigurationProperties} object is deprecated. This
027 * annotation has no bearing on the actual binding processes, but it is used by the
028 * {@code spring-boot-configuration-processor} to add deprecation meta-data.
029 * <p>
030 * This annotation <strong>must</strong> be used on the getter of the deprecated element.
031 *
032 * @author Phillip Webb
033 * @since 1.3.0
034 */
035@Target(ElementType.METHOD)
036@Retention(RetentionPolicy.RUNTIME)
037@Documented
038public @interface DeprecatedConfigurationProperty {
039
040        /**
041         * The reason for the deprecation.
042         * @return the deprecation reason
043         */
044        String reason() default "";
045
046        /**
047         * The field that should be used instead (if any).
048         * @return the replacement field
049         */
050        String replacement() default "";
051
052}