Modifier and Type	Class and Description
public static enum	ConstructorDetector.SingleArgConstructor Definition of alternate handling modes of single-argument constructors that are annotated with `com.fasterxml.jackson.annotation.JsonCreator` but without "mode" definition (or explicit name for the argument): this is the case where two interpretations are possible -- "properties" (in which case the argument is named parameter of a JSON Object) and "delegating (in which case the argument maps to the whole JSON value).

Field Summary

Modifier and Type	Field and Description
protected final boolean	_allowJDKTypeCtors Whether auto-detection of constructors of "JDK types" (those in packages `java.`
protected final boolean	_requireCtorAnnotation Whether explicit `com.fasterxml.jackson.annotation.JsonCreator` is always required for detecting constructors (even if visible) other than the default (no argument) constructor.
protected final ConstructorDetector.SingleArgConstructor	_singleArgMode
public static final ConstructorDetector	DEFAULT Instance used by default, which: Uses `SingleArgConstructor#HEURISTIC` for single-argument constructor case Does not require explicit `@JsonCreator` annotations (so allows auto-detection of Visible constructors} (except for JDK types) Does not allow auto-detection of Visible constructors for so-called JDK types; that is, classes in packages `java.` and `javax.`
public static final ConstructorDetector	EXPLICIT_ONLY Instance similar to `DEFAULT` except that for single-argument case uses setting of `SingleArgConstructor#REQUIRE_MODE`.
private static final long	serialVersionUID
public static final ConstructorDetector	USE_DELEGATING Instance similar to `DEFAULT` except that for single-argument case uses setting of `SingleArgConstructor#DELEGATING`.
public static final ConstructorDetector	USE_PROPERTIES_BASED Instance similar to `DEFAULT` except that for single-argument case uses setting of `SingleArgConstructor#PROPERTIES`.

Access	Constructor and Description
protected	ConstructorDetector(ConstructorDetector.SingleArgConstructor singleArgMode, boolean requireCtorAnnotation, boolean allowJDKTypeCtors)
protected	ConstructorDetector(ConstructorDetector.SingleArgConstructor singleArgMode) Constructors used for default configurations which only varies by `_singleArgMode`

Method Summary

Modifier and Type	Method and Description
public boolean	allowJDKTypeConstructors()
public boolean	requireCtorAnnotation()
public boolean	Returns: True if implicit constructor detection should be enabled; false if not shouldIntrospectorImplicitConstructors(Class<?> Value type to consider rawType) Accessor that combines checks for whether implicit creators are allowed and, if so, whether JDK type constructors are allowed (if type is JDK type) to determine whether implicit constructor detection should be enabled for given type or not.
public boolean	singleArgCreatorDefaultsToDelegating()
public boolean	singleArgCreatorDefaultsToProperties()
public ConstructorDetector.SingleArgConstructor	singleArgMode()
public ConstructorDetector	withAllowJDKTypeConstructors(boolean state)
public ConstructorDetector	withRequireAnnotation(boolean state)
public ConstructorDetector	withSingleArgMode(ConstructorDetector.SingleArgConstructor singleArgMode)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_allowJDKTypeCtors	back to summary
protected final boolean _allowJDKTypeCtors Whether auto-detection of constructors of "JDK types" (those in packages `java.` and `javax.`) is allowed or not

_requireCtorAnnotation	back to summary
protected final boolean _requireCtorAnnotation Whether explicit `com.fasterxml.jackson.annotation.JsonCreator` is always required for detecting constructors (even if visible) other than the default (no argument) constructor.

_singleArgMode	back to summary
protected final ConstructorDetector.SingleArgConstructor _singleArgMode

DEFAULT back to summary

DEFAULT	back to summary
public static final ConstructorDetector DEFAULT Instance used by default, which: Uses `SingleArgConstructor#HEURISTIC` for single-argument constructor case Does not require explicit `@JsonCreator` annotations (so allows auto-detection of Visible constructors} (except for JDK types) Does not allow auto-detection of Visible constructors for so-called JDK types; that is, classes in packages `java.` and `javax.`

public static final ConstructorDetector DEFAULT

Instance used by default, which:

Uses SingleArgConstructor#HEURISTIC for single-argument constructor case
Does not require explicit @JsonCreator annotations (so allows auto-detection of Visible constructors} (except for JDK types)
Does not allow auto-detection of Visible constructors for so-called JDK types; that is, classes in packages java.* and javax.*

EXPLICIT_ONLY	back to summary
public static final ConstructorDetector EXPLICIT_ONLY Instance similar to `DEFAULT` except that for single-argument case uses setting of `SingleArgConstructor#REQUIRE_MODE`.

serialVersionUID	back to summary
private static final long serialVersionUID

USE_DELEGATING	back to summary
public static final ConstructorDetector USE_DELEGATING Instance similar to `DEFAULT` except that for single-argument case uses setting of `SingleArgConstructor#DELEGATING`.

USE_PROPERTIES_BASED	back to summary
public static final ConstructorDetector USE_PROPERTIES_BASED Instance similar to `DEFAULT` except that for single-argument case uses setting of `SingleArgConstructor#PROPERTIES`.

ConstructorDetector	back to summary
protected ConstructorDetector(ConstructorDetector.SingleArgConstructor singleArgMode, boolean requireCtorAnnotation, boolean allowJDKTypeCtors)

ConstructorDetector	back to summary
protected ConstructorDetector(ConstructorDetector.SingleArgConstructor singleArgMode) Constructors used for default configurations which only varies by `_singleArgMode`

Method Detail

allowJDKTypeConstructors	back to summary
public boolean allowJDKTypeConstructors()

requireCtorAnnotation	back to summary
public boolean requireCtorAnnotation()

shouldIntrospectorImplicitConstructors	back to summary
public boolean shouldIntrospectorImplicitConstructors(Class<?> rawType) Accessor that combines checks for whether implicit creators are allowed and, if so, whether JDK type constructors are allowed (if type is JDK type) to determine whether implicit constructor detection should be enabled for given type or not. Parameters rawType:Class<?> Value type to consider Returns:boolean True if implicit constructor detection should be enabled; false if not

shouldIntrospectorImplicitConstructors

back to summary

public boolean shouldIntrospectorImplicitConstructors(Class<?> rawType)

Accessor that combines checks for whether implicit creators are allowed and, if so, whether JDK type constructors are allowed (if type is JDK type) to determine whether implicit constructor detection should be enabled for given type or not.

Parameters

rawType:Class<?>: Value type to consider

Returns:boolean

True if implicit constructor detection should be enabled; false if not

singleArgCreatorDefaultsToDelegating	back to summary
public boolean singleArgCreatorDefaultsToDelegating()

singleArgCreatorDefaultsToProperties	back to summary
public boolean singleArgCreatorDefaultsToProperties()

singleArgMode	back to summary
public ConstructorDetector.SingleArgConstructor singleArgMode()

withAllowJDKTypeConstructors	back to summary
public ConstructorDetector withAllowJDKTypeConstructors(boolean state)

withRequireAnnotation	back to summary
public ConstructorDetector withRequireAnnotation(boolean state)

withSingleArgMode	back to summary
public ConstructorDetector withSingleArgMode(ConstructorDetector.SingleArgConstructor singleArgMode)

com.fasterxml.jackson.databind.cfg back to summary

public final Enum ConstructorDetector.SingleArgConstructor

Class Inheritance

extends Enum<ConstructorDetector.SingleArgConstructor>

java.lang.Object
java.lang.Enum
com.fasterxml.jackson.databind.cfg.ConstructorDetector.SingleArgConstructor

Definition of alternate handling modes of single-argument constructors that are annotated with com.fasterxml.jackson.annotation.JsonCreator but without "mode" definition (or explicit name for the argument): this is the case where two interpretations are possible -- "properties" (in which case the argument is named parameter of a JSON Object) and "delegating (in which case the argument maps to the whole JSON value).

Default choice is HEURISTIC (which is Jackson pre-2.12 always uses)

Note

does NOT have any effect if explicit @JsonCreator annotation is required.

Since: 2.12

Field Summary

Modifier and Type	Field and Description
public static final ConstructorDetector.SingleArgConstructor	DELEGATING Assume "delegating" mode if not explicitly annotated otherwise
public static final ConstructorDetector.SingleArgConstructor	HEURISTIC Use heuristics to see if "properties" mode is to be used (POJO has a property with the same name as the implicit name [if available] of the constructor argument).
public static final ConstructorDetector.SingleArgConstructor	PROPERTIES Assume "properties" mode if not explicitly annotated otherwise
public static final ConstructorDetector.SingleArgConstructor	REQUIRE_MODE Refuse to decide implicit mode and instead throw a `com.fasterxml.jackson.databind.exc.InvalidDefinitionException` in ambiguous case.

Constructor Summary

Access	Constructor and Description
private	SingleArgConstructor()

Method Summary

Modifier and Type	Method and Description
public static ConstructorDetector.SingleArgConstructor	valueOf(String name)
public static ConstructorDetector.SingleArgConstructor[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DELEGATING	back to summary
public static final ConstructorDetector.SingleArgConstructor DELEGATING Assume "delegating" mode if not explicitly annotated otherwise

HEURISTIC	back to summary
public static final ConstructorDetector.SingleArgConstructor HEURISTIC Use heuristics to see if "properties" mode is to be used (POJO has a property with the same name as the implicit name [if available] of the constructor argument). Note this is the default choice for Jackson versions before 2.12.

PROPERTIES	back to summary
public static final ConstructorDetector.SingleArgConstructor PROPERTIES Assume "properties" mode if not explicitly annotated otherwise

REQUIRE_MODE	back to summary
public static final ConstructorDetector.SingleArgConstructor REQUIRE_MODE Refuse to decide implicit mode and instead throw a `com.fasterxml.jackson.databind.exc.InvalidDefinitionException` in ambiguous case.

Constructor Detail

SingleArgConstructor	back to summary
private SingleArgConstructor()

Method Detail

valueOf	back to summary
public static ConstructorDetector.SingleArgConstructor valueOf(String name)

values	back to summary
public static ConstructorDetector.SingleArgConstructor[] values()

public final Class ConstructorDetector

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ConstructorDetector.SingleArgConstructor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail