org.springframework.beans.PropertyAccessException Maven / Gradle / Ivy
/*
* 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
*
* 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.beans;
import java.beans.PropertyChangeEvent;
import org.springframework.lang.Nullable;
/**
* Superclass for exceptions related to a property access,
* such as type mismatch or invocation target exception.
*
* @author Rod Johnson
* @author Juergen Hoeller
*/
@SuppressWarnings("serial")
public abstract class PropertyAccessException extends BeansException {
@Nullable
private final PropertyChangeEvent propertyChangeEvent;
/**
* Create a new PropertyAccessException.
* @param propertyChangeEvent the PropertyChangeEvent that resulted in the problem
* @param msg the detail message
* @param cause the root cause
*/
public PropertyAccessException(PropertyChangeEvent propertyChangeEvent, String msg, @Nullable Throwable cause) {
super(msg, cause);
this.propertyChangeEvent = propertyChangeEvent;
}
/**
* Create a new PropertyAccessException without PropertyChangeEvent.
* @param msg the detail message
* @param cause the root cause
*/
public PropertyAccessException(String msg, @Nullable Throwable cause) {
super(msg, cause);
this.propertyChangeEvent = null;
}
/**
* Return the PropertyChangeEvent that resulted in the problem.
* May be {@code null}; only available if an actual bean property
* was affected.
*/
@Nullable
public PropertyChangeEvent getPropertyChangeEvent() {
return this.propertyChangeEvent;
}
/**
* Return the name of the affected property, if available.
*/
@Nullable
public String getPropertyName() {
return (this.propertyChangeEvent != null ? this.propertyChangeEvent.getPropertyName() : null);
}
/**
* Return the affected value that was about to be set, if any.
*/
@Nullable
public Object getValue() {
return (this.propertyChangeEvent != null ? this.propertyChangeEvent.getNewValue() : null);
}
/**
* Return a corresponding error code for this type of exception.
*/
public abstract String getErrorCode();
}