Skip to content

Commit f29fb29

Browse files
committed
Minor Javadoc improvements for @JacksonInject.id
1 parent 59e536d commit f29fb29

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/main/java/com/fasterxml/jackson/annotation/JacksonInject.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
/**
1010
* Jackson-specific annotation used for indicating that value of
1111
* annotated property will be "injected", i.e. set based on value
12-
* configured by <code>ObjectMapper</code> (usually on per-call basis).
12+
* configured by {@code ObjectMapper} or {@code ObjectReader} (usually on per-call basis).
1313
* Usually property is not deserialized from JSON, although it is possible
1414
* to have injected value as default and still allow optional override
1515
* from JSON.
@@ -21,7 +21,8 @@
2121
{
2222
/**
2323
* Logical id of the value to inject; if not specified (or specified
24-
* as empty String), will use id based on declared type of property.
24+
* as empty String), will use id based on declared <b>type</b> of property
25+
* (NOT name of property).
2526
*
2627
* @return Logical id of the value to inject
2728
*/
@@ -41,11 +42,11 @@
4142
public OptBoolean useInput() default OptBoolean.DEFAULT;
4243

4344
/**
44-
* Whether to throw an exception when the {@code ObjectMapper} does not find
45-
* the value to inject.
45+
* Whether to throw an exception when the value to inject is not found from
46+
* {@code ObjectMapper} or {@code ObjectReader} used for reading.
4647
*<p>
4748
* Default is {@code OptBoolean.DEFAULT} for backwards-compatibility: in this
48-
* case {@code ObjectMapper} defaults are used (which in turn are same
49+
* case mapper/reader defaults are used (which in turn are same
4950
* as {code OptBoolean.FALSE}).
5051
*
5152
* @return {@link OptBoolean#FALSE} to throw an exception; {@link OptBoolean#TRUE}
@@ -78,7 +79,8 @@ public static class Value
7879

7980
/**
8081
* Id to use to access injected value; if `null`, "default" name, derived
81-
* from accessor will be used.
82+
* from the <b>type</b> of accessor will be used (specifically, class name
83+
* of Field type, or setter parameter type).
8284
*/
8385
protected final Object _id;
8486

0 commit comments

Comments
 (0)