org.springframework.validation.ObjectError Maven / Gradle / Ivy
/*
* Copyright 2002-2006 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 org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.util.Assert;
/**
* Encapsulates an object error, that is, a global reason for rejecting
* an object.
*
* See the {@link DefaultMessageCodesResolver} javadoc for details on
* how a message code list is built for an ObjectError.
*
* @author Juergen Hoeller
* @see FieldError
* @see DefaultMessageCodesResolver
* @since 10.03.2003
*/
public class ObjectError extends DefaultMessageSourceResolvable {
private final String objectName;
/**
* Creates a new instance of the {@link ObjectError} class.
* @param objectName the name of the affected object
* @param codes the codes to be used to resolve this message
* @param arguments the array of arguments to be used to resolve this message
* @param defaultMessage the default message to be used to resolve this message
* @throws IllegalArgumentException if the supplied objectName is null
*/
public ObjectError(String objectName, String[] codes, Object[] arguments, String defaultMessage) {
super(codes, arguments, defaultMessage);
Assert.notNull(objectName, "Object name must not be null");
this.objectName = objectName;
}
/**
* Return the name of the affected object.
*/
public String getObjectName() {
return objectName;
}
public String toString() {
return "Error in object '" + this.objectName + "': " + resolvableToString();
}
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (!(getClass().equals(other.getClass())) || !super.equals(other)) {
return false;
}
ObjectError otherError = (ObjectError) other;
return getObjectName().equals(otherError.getObjectName());
}
public int hashCode() {
return super.hashCode() * 29 + getObjectName().hashCode();
}
}