/*
 * Copyright 2002-2018 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
 *
 *      http://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.validation;

import java.beans.PropertyEditor;
import java.util.List;
import java.util.Map;

import org.springframework.beans.PropertyEditorRegistry;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

Thrown when binding errors are considered fatal. Implements the BindingResult interface (and its super-interface Errors) to allow for the direct analysis of binding errors.

As of Spring 2.0, this is a special-purpose class. Normally, application code will work with the BindingResult interface, or with a DataBinder that in turn exposes a BindingResult via DataBinder.getBindingResult().

Author:Rod Johnson, Juergen Hoeller, Rob Harrop
See Also:
/** * Thrown when binding errors are considered fatal. Implements the * {@link BindingResult} interface (and its super-interface {@link Errors}) * to allow for the direct analysis of binding errors. * * <p>As of Spring 2.0, this is a special-purpose class. Normally, * application code will work with the {@link BindingResult} interface, * or with a {@link DataBinder} that in turn exposes a BindingResult via * {@link org.springframework.validation.DataBinder#getBindingResult()}. * * @author Rod Johnson * @author Juergen Hoeller * @author Rob Harrop * @see BindingResult * @see DataBinder#getBindingResult() * @see DataBinder#close() */
@SuppressWarnings("serial") public class BindException extends Exception implements BindingResult { private final BindingResult bindingResult;
Create a new BindException instance for a BindingResult.
Params:
  • bindingResult – the BindingResult instance to wrap
/** * Create a new BindException instance for a BindingResult. * @param bindingResult the BindingResult instance to wrap */
public BindException(BindingResult bindingResult) { Assert.notNull(bindingResult, "BindingResult must not be null"); this.bindingResult = bindingResult; }
Create a new BindException instance for a target bean.
Params:
  • target – target bean to bind onto
  • objectName – the name of the target object
See Also:
/** * Create a new BindException instance for a target bean. * @param target target bean to bind onto * @param objectName the name of the target object * @see BeanPropertyBindingResult */
public BindException(Object target, String objectName) { Assert.notNull(target, "Target object must not be null"); this.bindingResult = new BeanPropertyBindingResult(target, objectName); }
Return the BindingResult that this BindException wraps. Will typically be a BeanPropertyBindingResult.
See Also:
  • BeanPropertyBindingResult
/** * Return the BindingResult that this BindException wraps. * Will typically be a BeanPropertyBindingResult. * @see BeanPropertyBindingResult */
public final BindingResult getBindingResult() { return this.bindingResult; } @Override public String getObjectName() { return this.bindingResult.getObjectName(); } @Override public void setNestedPath(String nestedPath) { this.bindingResult.setNestedPath(nestedPath); } @Override public String getNestedPath() { return this.bindingResult.getNestedPath(); } @Override public void pushNestedPath(String subPath) { this.bindingResult.pushNestedPath(subPath); } @Override public void popNestedPath() throws IllegalStateException { this.bindingResult.popNestedPath(); } @Override public void reject(String errorCode) { this.bindingResult.reject(errorCode); } @Override public void reject(String errorCode, String defaultMessage) { this.bindingResult.reject(errorCode, defaultMessage); } @Override public void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage) { this.bindingResult.reject(errorCode, errorArgs, defaultMessage); } @Override public void rejectValue(@Nullable String field, String errorCode) { this.bindingResult.rejectValue(field, errorCode); } @Override public void rejectValue(@Nullable String field, String errorCode, String defaultMessage) { this.bindingResult.rejectValue(field, errorCode, defaultMessage); } @Override public void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage) { this.bindingResult.rejectValue(field, errorCode, errorArgs, defaultMessage); } @Override public void addAllErrors(Errors errors) { this.bindingResult.addAllErrors(errors); } @Override public boolean hasErrors() { return this.bindingResult.hasErrors(); } @Override public int getErrorCount() { return this.bindingResult.getErrorCount(); } @Override public List<ObjectError> getAllErrors() { return this.bindingResult.getAllErrors(); } @Override public boolean hasGlobalErrors() { return this.bindingResult.hasGlobalErrors(); } @Override public int getGlobalErrorCount() { return this.bindingResult.getGlobalErrorCount(); } @Override public List<ObjectError> getGlobalErrors() { return this.bindingResult.getGlobalErrors(); } @Override @Nullable public ObjectError getGlobalError() { return this.bindingResult.getGlobalError(); } @Override public boolean hasFieldErrors() { return this.bindingResult.hasFieldErrors(); } @Override public int getFieldErrorCount() { return this.bindingResult.getFieldErrorCount(); } @Override public List<FieldError> getFieldErrors() { return this.bindingResult.getFieldErrors(); } @Override @Nullable public FieldError getFieldError() { return this.bindingResult.getFieldError(); } @Override public boolean hasFieldErrors(String field) { return this.bindingResult.hasFieldErrors(field); } @Override public int getFieldErrorCount(String field) { return this.bindingResult.getFieldErrorCount(field); } @Override public List<FieldError> getFieldErrors(String field) { return this.bindingResult.getFieldErrors(field); } @Override @Nullable public FieldError getFieldError(String field) { return this.bindingResult.getFieldError(field); } @Override @Nullable public Object getFieldValue(String field) { return this.bindingResult.getFieldValue(field); } @Override @Nullable public Class<?> getFieldType(String field) { return this.bindingResult.getFieldType(field); } @Override public Object getTarget() { return this.bindingResult.getTarget(); } @Override public Map<String, Object> getModel() { return this.bindingResult.getModel(); } @Override @Nullable public Object getRawFieldValue(String field) { return this.bindingResult.getRawFieldValue(field); } @Override @SuppressWarnings("rawtypes") @Nullable public PropertyEditor findEditor(@Nullable String field, @Nullable Class valueType) { return this.bindingResult.findEditor(field, valueType); } @Override @Nullable public PropertyEditorRegistry getPropertyEditorRegistry() { return this.bindingResult.getPropertyEditorRegistry(); } @Override public String[] resolveMessageCodes(String errorCode) { return this.bindingResult.resolveMessageCodes(errorCode); } @Override public String[] resolveMessageCodes(String errorCode, String field) { return this.bindingResult.resolveMessageCodes(errorCode, field); } @Override public void addError(ObjectError error) { this.bindingResult.addError(error); } @Override public void recordFieldValue(String field, Class<?> type, @Nullable Object value) { this.bindingResult.recordFieldValue(field, type, value); } @Override public void recordSuppressedField(String field) { this.bindingResult.recordSuppressedField(field); } @Override public String[] getSuppressedFields() { return this.bindingResult.getSuppressedFields(); }
Returns diagnostic information about the errors held in this object.
/** * Returns diagnostic information about the errors held in this object. */
@Override public String getMessage() { return this.bindingResult.toString(); } @Override public boolean equals(Object other) { return (this == other || this.bindingResult.equals(other)); } @Override public int hashCode() { return this.bindingResult.hashCode(); } }