org.springframework.boot.context.properties.bind.DefaultValue Maven / Gradle / Ivy
/*
* Copyright 2012-2022 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.context.properties.bind;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation that can be used to specify the default value when binding to an immutable
* property. This annotation can also be used with nested properties to indicate that a
* value should always be bound (rather than binding {@code null}). The value from this
* annotation will only be used if the property is not found in the property sources used
* by the {@link Binder}. For example, if the property is present in the
* {@link org.springframework.core.env.Environment} when binding to
* {@link org.springframework.boot.context.properties.ConfigurationProperties @ConfigurationProperties},
* the default value for the property will not be used even if the property value is
* empty.
*
* NOTE: This annotation does not support property placeholder resolution and the value
* must be constant.
*
* @author Madhura Bhave
* @since 2.2.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PARAMETER })
@Documented
public @interface DefaultValue {
/**
* The default value of the property. Can be an array of values for collection or
* array-based properties.
* @return the default value of the property.
*/
String[] value() default {};
}