Add comments regarding config overrides
diff --git a/src/main/java/com/fasterxml/jackson/databind/cfg/ConfigOverride.java b/src/main/java/com/fasterxml/jackson/databind/cfg/ConfigOverride.java
index 78b261b..9d1d1f4 100644
--- a/src/main/java/com/fasterxml/jackson/databind/cfg/ConfigOverride.java
+++ b/src/main/java/com/fasterxml/jackson/databind/cfg/ConfigOverride.java
@@ -87,6 +87,10 @@
public JsonFormat.Value getFormat() { return _format; }
public JsonInclude.Value getInclude() { return _include; }
+
+ /**
+ * @since 2.9
+ */
public JsonInclude.Value getIncludeAsProperty() { return _includeAsProperty; }
public JsonIgnoreProperties.Value getIgnorals() { return _ignorals; }
diff --git a/src/main/java/com/fasterxml/jackson/databind/cfg/MapperConfig.java b/src/main/java/com/fasterxml/jackson/databind/cfg/MapperConfig.java
index c21cb98..a737025 100644
--- a/src/main/java/com/fasterxml/jackson/databind/cfg/MapperConfig.java
+++ b/src/main/java/com/fasterxml/jackson/databind/cfg/MapperConfig.java
@@ -414,6 +414,9 @@
* NOTE: if no override found, defaults to value returned by
* {@link #getDefaultPropertyInclusion()}.
*
+ * @param baseType Type of the instance containing the targeted property.
+ * @param propertyType Type of the property to look up inclusion setting for.
+ *
* @since 2.9
*/
public abstract JsonInclude.Value getDefaultInclusion(Class<?> baseType,
@@ -425,6 +428,8 @@
* possible per-type override for given property type; but
* if none found, returning given <code>defaultIncl</code>
*
+ * @param baseType Type of the instance containing the targeted property.
+ * @param propertyType Type of the property to look up inclusion setting for.
* @param defaultIncl Inclusion setting to return if no overrides found.
*
* @since 2.9
diff --git a/src/main/java/com/fasterxml/jackson/databind/cfg/MutableConfigOverride.java b/src/main/java/com/fasterxml/jackson/databind/cfg/MutableConfigOverride.java
index e48be3f..b30b99b 100644
--- a/src/main/java/com/fasterxml/jackson/databind/cfg/MutableConfigOverride.java
+++ b/src/main/java/com/fasterxml/jackson/databind/cfg/MutableConfigOverride.java
@@ -36,11 +36,25 @@
return this;
}
+ /**
+ * Override inclusion setting for all properties contained in POJOs of the
+ * associated type.
+ *
+ * @param v Inclusion setting to apply contained properties.
+ */
public MutableConfigOverride setInclude(JsonInclude.Value v) {
_include = v;
return this;
}
+ /**
+ * Override inclusion setting for properties of the associated type
+ * regardless of the type of the POJO containing it.
+ *
+ * @param v Inclusion setting to apply for properties of associated type.
+ *
+ * @since 2.9
+ */
public MutableConfigOverride setIncludeAsProperty(JsonInclude.Value v) {
_includeAsProperty = v;
return this;
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/PropertyBuilder.java b/src/main/java/com/fasterxml/jackson/databind/ser/PropertyBuilder.java
index 68dda77..b3499e7 100644
--- a/src/main/java/com/fasterxml/jackson/databind/ser/PropertyBuilder.java
+++ b/src/main/java/com/fasterxml/jackson/databind/ser/PropertyBuilder.java
@@ -57,7 +57,8 @@
// (a) global default inclusion
// (b) per-type default inclusion (from annotation or config overrides;
// config override having precedence)
- // (c) per-property override (from annotation or config overrides;
+ // (c) per-property override (from annotation on specific property or
+ // config overrides per type of property;
// annotation having precedence)
//
// and not only requiring merging, but also considering special handling
