Module tools.jackson.databind

Package tools.jackson.databind.cfg

Class ConstructorDetector

java.lang.Object

tools.jackson.databind.cfg.ConstructorDetector

All Implemented Interfaces:

Serializable

public final class ConstructorDetector
extends Object
implements Serializable

Configurable handler used to select aspects of selecting constructor(s) to use as "Creators" for POJOs. Defines the API for handlers, a pre-defined set of standard instances and methods for constructing alternative configurations.

Since:

2.12

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConstructorDetector.SingleArgConstructor	Definition of alternate handling modes of single-argument constructors that are annotated with 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

Fields

Modifier and Type	Field	Description
protected final boolean	_allowImplicitWithDefaultConstructor	Whether implicit detection of Properties-based Constructors is allowed when there is the default (no-parameter) constructor available.
protected final boolean	_allowJDKTypeCtors	Whether auto-detection of constructors of "JDK types" (those in packages java. and javax.) is allowed or not
protected final boolean	_requireCtorAnnotation	Whether explicit JsonCreator is always required for detecting constructors (even if visible) other than the default (no argument) constructor.
protected final ConstructorDetector.SingleArgConstructor	_singleArgMode
static final ConstructorDetector	DEFAULT	Instance used by default, which: Uses ConstructorDetector.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.*
static final boolean	DEFAULT_ALLOW_IMPLICIT_WITH_DEFAULT_CONSTRUCTOR	See allowImplicitWithDefaultConstructor() for details.
static final ConstructorDetector	EXPLICIT_ONLY	Instance similar to DEFAULT except that for single-argument case uses setting of ConstructorDetector.SingleArgConstructor.REQUIRE_MODE.
static final ConstructorDetector	USE_DELEGATING	Instance similar to DEFAULT except that for single-argument case uses setting of ConstructorDetector.SingleArgConstructor.DELEGATING.
static final ConstructorDetector	USE_PROPERTIES_BASED	Instance similar to DEFAULT except that for single-argument case uses setting of ConstructorDetector.SingleArgConstructor.PROPERTIES.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	allowImplicitWithDefaultConstructor()	Method that can be used to determine whether implicit detection of Properties-based Constructors is allowed when there is a default (no-parameter) constructor available.
boolean	allowJDKTypeConstructors()
boolean	requireCtorAnnotation()
boolean	shouldIntrospectImplicitConstructors(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.
boolean	singleArgCreatorDefaultsToDelegating()
boolean	singleArgCreatorDefaultsToProperties()
ConstructorDetector.SingleArgConstructor	singleArgMode()
ConstructorDetector	withAllowImplicitWithDefaultConstructor(boolean state)	Mutant factory method that can be used to change setting that allowImplicitWithDefaultConstructor() returns.
ConstructorDetector	withAllowJDKTypeConstructors(boolean state)
ConstructorDetector	withRequireAnnotation(boolean state)
ConstructorDetector	withSingleArgMode(ConstructorDetector.SingleArgConstructor singleArgMode)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ALLOW_IMPLICIT_WITH_DEFAULT_CONSTRUCTOR

public static final boolean DEFAULT_ALLOW_IMPLICIT_WITH_DEFAULT_CONSTRUCTOR

See allowImplicitWithDefaultConstructor() for details.

Since:

3.0

See Also:

• Constant Field Values

DEFAULT

public static final ConstructorDetector DEFAULT

Instance used by default, which:

• Uses ConstructorDetector.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.*

USE_PROPERTIES_BASED

public static final ConstructorDetector USE_PROPERTIES_BASED

Instance similar to DEFAULT except that for single-argument case uses setting of ConstructorDetector.SingleArgConstructor.PROPERTIES.

USE_DELEGATING

public static final ConstructorDetector USE_DELEGATING

Instance similar to DEFAULT except that for single-argument case uses setting of ConstructorDetector.SingleArgConstructor.DELEGATING.

EXPLICIT_ONLY

public static final ConstructorDetector EXPLICIT_ONLY

Instance similar to DEFAULT except that for single-argument case uses setting of ConstructorDetector.SingleArgConstructor.REQUIRE_MODE.

_singleArgMode

protected final ConstructorDetector.SingleArgConstructor _singleArgMode

_requireCtorAnnotation

protected final boolean _requireCtorAnnotation

Whether explicit JsonCreator is always required for detecting constructors (even if visible) other than the default (no argument) constructor.

_allowJDKTypeCtors

protected final boolean _allowJDKTypeCtors

Whether auto-detection of constructors of "JDK types" (those in packages java. and javax.) is allowed or not

_allowImplicitWithDefaultConstructor

protected final boolean _allowImplicitWithDefaultConstructor

Whether implicit detection of Properties-based Constructors is allowed when there is the default (no-parameter) constructor available.

Since:

3.0

Constructor Details

ConstructorDetector

protected ConstructorDetector(ConstructorDetector.SingleArgConstructor singleArgMode,
 boolean requireCtorAnnotation,
 boolean allowJDKTypeCtors,
 boolean allowImplicitWithDefaultConstructor)

ConstructorDetector

protected ConstructorDetector(ConstructorDetector.SingleArgConstructor singleArgMode)

Constructors used for default configurations which only varies by _singleArgMode

Method Details

withSingleArgMode

public ConstructorDetector withSingleArgMode(ConstructorDetector.SingleArgConstructor singleArgMode)

withRequireAnnotation

public ConstructorDetector withRequireAnnotation(boolean state)

withAllowJDKTypeConstructors

public ConstructorDetector withAllowJDKTypeConstructors(boolean state)

withAllowImplicitWithDefaultConstructor

public ConstructorDetector withAllowImplicitWithDefaultConstructor(boolean state)

Mutant factory method that can be used to change setting that allowImplicitWithDefaultConstructor() returns.

Since:

3.0

singleArgMode

public ConstructorDetector.SingleArgConstructor singleArgMode()

requireCtorAnnotation

public boolean requireCtorAnnotation()

allowJDKTypeConstructors

public boolean allowJDKTypeConstructors()

allowImplicitWithDefaultConstructor

public boolean allowImplicitWithDefaultConstructor()

Method that can be used to determine whether implicit detection of Properties-based Constructors is allowed when there is a default (no-parameter) constructor available. Note that this only matters if shouldIntrospectImplicitConstructors(java.lang.Class<?>) returns true.

Since:

3.0

singleArgCreatorDefaultsToDelegating

public boolean singleArgCreatorDefaultsToDelegating()

singleArgCreatorDefaultsToProperties

public boolean singleArgCreatorDefaultsToProperties()

shouldIntrospectImplicitConstructors

public boolean shouldIntrospectImplicitConstructors(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 - Value type to consider

Returns:

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