Class InvalidPropertyPathException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.core.NestedRuntimeException

org.springframework.beans.BeansException

org.springframework.beans.PropertyAccessException

org.springframework.beans.InvalidPropertyPathException

All Implemented Interfaces:

Serializable

public class InvalidPropertyPathException
extends PropertyAccessException

Exception thrown when a property path is not well-formed according to the grammar implemented by PropertyPath.

This signals a syntactically invalid path, as opposed to a syntactically valid path that happens not to resolve against a particular target object. The latter cases are reported as NotReadablePropertyException or NotWritablePropertyException instead.

Extends PropertyAccessException so that a malformed path encountered while binding a single property value can be collected into a PropertyBatchUpdateException alongside other per-property failures, rather than aborting the whole binding operation.

Since:

7.1

Author:

Brian Clozel

See Also:

• PropertyPath.parse(String)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_CODE	Error code that an InvalidPropertyPathException is registered with.

Constructor Summary

Constructors

Constructor	Description
InvalidPropertyPathException(PropertyChangeEvent propertyChangeEvent, InvalidPropertyPathException cause)	Create a new InvalidPropertyPathException.
InvalidPropertyPathException(Object source, String propertyName, @Nullable Object newValue, InvalidPropertyPathException cause)	Create a new InvalidPropertyPathException.
InvalidPropertyPathException(String propertyPath, String reason)	Create a new InvalidPropertyPathException.

Method Summary

Modifier and Type	Method	Description
String	getErrorCode()	Return a corresponding error code for this type of exception.
String	getPropertyPath()	Return the offending property path.

Methods inherited from class PropertyAccessException

getPropertyChangeEvent, getPropertyName, getValue

Methods inherited from class NestedRuntimeException

contains, getMostSpecificCause, getRootCause

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ERROR_CODE

public static final String ERROR_CODE

Error code that an InvalidPropertyPathException is registered with.

See Also:

• Constant Field Values

Constructor Details

InvalidPropertyPathException

public InvalidPropertyPathException(String propertyPath,
 String reason)

Create a new InvalidPropertyPathException.

Parameters:

propertyPath - the offending property path

reason - a description of the grammar rule that was violated

InvalidPropertyPathException

public InvalidPropertyPathException(PropertyChangeEvent propertyChangeEvent,
 InvalidPropertyPathException cause)

Create a new InvalidPropertyPathException.

Parameters:

propertyChangeEvent - the event for the property

cause - the original parsing exception

InvalidPropertyPathException

public InvalidPropertyPathException(Object source,
 String propertyName,
 @Nullable Object newValue,
 InvalidPropertyPathException cause)

Create a new InvalidPropertyPathException.

Parameters:

source - the bean that fired the event

propertyName - the programmatic name of the property that was changed

newValue - the new value of the property

cause - the original parsing exception

Method Details

getPropertyPath

public String getPropertyPath()

Return the offending property path.

getErrorCode

public String getErrorCode()

Description copied from class: PropertyAccessException

Return a corresponding error code for this type of exception.

Specified by:

getErrorCode in class PropertyAccessException