Skip to content

Commit 39ebd7e

Browse files
committed
Improve Javadocs for PropertyBindingException
1 parent 14ded7b commit 39ebd7e

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/main/java/com/fasterxml/jackson/databind/exc/PropertyBindingException.java

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,22 @@ public abstract class PropertyBindingException
1919
extends MismatchedInputException // since 2.9
2020
{
2121
/**
22-
* Class that does not contain mapping for the unrecognized property.
22+
* Class that has the problem with mapping of a property (unrecognized,
23+
* missing, etc).
2324
*/
2425
protected final Class<?> _referringClass;
2526

2627
/**
28+
* Name of property that has the problem being reported.
2729
*<p>
28-
* Note: redundant information since it is also included in the
29-
* reference path.
30+
* Note: possibly redundant information since it may also included
31+
* in the reference path.
3032
*/
3133
protected final String _propertyName;
3234

3335
/**
34-
* Set of ids of properties that are known for the type, if this
35-
* can be statically determined.
36+
* Set of ids of properties that are known for the type (see
37+
* {@code _referringClass}, if ids can be statically determined.
3638
*/
3739
protected final Collection<Object> _propertyIds;
3840

@@ -119,17 +121,17 @@ public String getMessageSuffix()
119121
*/
120122

121123
/**
122-
* Method for accessing type (class) that is missing definition to allow
123-
* binding of the unrecognized property.
124+
* Method for accessing type (class) that has the problematic property.
124125
*/
125126
public Class<?> getReferringClass() {
126127
return _referringClass;
127128
}
128129

129130
/**
130131
* Convenience method for accessing logical property name that could
131-
* not be mapped. Note that it is the last path reference in the
132-
* underlying path.
132+
* not be mapped (see {@link #_propertyName}).
133+
* Note that it is likely the last path reference in the underlying path
134+
* (but not necessarily, depending on the type of problem).
133135
*/
134136
public String getPropertyName() {
135137
return _propertyName;

0 commit comments

Comments
 (0)