BindException Class — spring-boot Architecture

Source Code

core/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/BindException.java lines 33–86

public class BindException extends RuntimeException implements OriginProvider {

	private final Bindable<?> target;

	private final @Nullable ConfigurationProperty property;

	private final ConfigurationPropertyName name;

	BindException(ConfigurationPropertyName name, Bindable<?> target, @Nullable ConfigurationProperty property,
			@Nullable Throwable cause) {
		super(buildMessage(name, target), cause);
		this.name = name;
		this.target = target;
		this.property = property;
	}

	/**
	 * Return the name of the configuration property being bound.
	 * @return the configuration property name
	 */
	public ConfigurationPropertyName getName() {
		return this.name;
	}

	/**
	 * Return the target being bound.
	 * @return the bind target
	 */
	public Bindable<?> getTarget() {
		return this.target;
	}

	/**
	 * Return the configuration property name of the item that was being bound.
	 * @return the configuration property name
	 */
	public @Nullable ConfigurationProperty getProperty() {
		return this.property;
	}

	@Override
	public @Nullable Origin getOrigin() {
		return Origin.from(this.name);
	}

	private static String buildMessage(@Nullable ConfigurationPropertyName name, Bindable<?> target) {
		StringBuilder message = new StringBuilder();
		message.append("Failed to bind properties");
		message.append((name != null) ? " under '" + name + "'" : "");
		message.append(" to ").append(target.getType());
		return message.toString();
	}

}