org.springframework.boot.configurationmetadata.Deprecation.java Source code

Introduction

Here is the source code for org.springframework.boot.configurationmetadata.Deprecation.java

Source

/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.configurationmetadata;

import java.io.Serializable;

/**
 * Indicate that a property is deprecated. Provide additional information about the
 * deprecation.
 *
 * @author Stephane Nicoll
 * @since 1.3.0
 */
@SuppressWarnings("serial")
public class Deprecation implements Serializable {

    private Level level = Level.WARNING;

    private String reason;

    private String shortReason;

    private String replacement;

    /**
     * Define the {@link Level} of deprecation.
     * @return the deprecation level
     */
    public Level getLevel() {
        return this.level;
    }

    public void setLevel(Level level) {
        this.level = level;
    }

    /**
     * A reason why the related property is deprecated, if any. Can be multi-lines.
     * @return the deprecation reason
     * @see #getShortReason()
     */
    public String getReason() {
        return this.reason;
    }

    public void setReason(String reason) {
        this.reason = reason;
    }

    /**
     * A single-line, single-sentence reason why the related property is deprecated, if
     * any.
     * @return the short deprecation reason
     * @see #getReason()
     */
    public String getShortReason() {
        return this.shortReason;
    }

    public void setShortReason(String shortReason) {
        this.shortReason = shortReason;
    }

    /**
     * The full name of the property that replaces the related deprecated property, if
     * any.
     * @return the replacement property name
     */
    public String getReplacement() {
        return this.replacement;
    }

    public void setReplacement(String replacement) {
        this.replacement = replacement;
    }

    @Override
    public String toString() {
        return "Deprecation{level='" + this.level + '\'' + ", reason='" + this.reason + '\'' + ", replacement='"
                + this.replacement + '\'' + '}';
    }

    /**
     * Define the deprecation level.
     */
    public enum Level {

        /**
         * The property is still bound.
         */
        WARNING,

        /**
         * The property has been removed and is no longer bound.
         */
        ERROR

    }

}