Class ValueInstantiator.Delegating
- All Implemented Interfaces:
Serializable
- Enclosing class:
- ValueInstantiator
ValueInstantiator
implementation meant as a base type
that by default delegates methods to specified fallback instantiator.- Since:
- 2.12
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.ValueInstantiator
ValueInstantiator.Base, ValueInstantiator.Delegating, ValueInstantiator.Gettable
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Method that can be called to check whether a double (boolean / Boolean) based creator is available to use (to callValueInstantiator.createFromDouble(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, double)
).boolean
Method that can be called to check whether a double (double / Double) based creator is available to use (to callValueInstantiator.createFromDouble(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, double)
).boolean
Method that can be called to check whether an integer (int, Integer) based creator is available to use (to callValueInstantiator.createFromInt(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, int)
).boolean
Method that can be called to check whether a long (long, Long) based creator is available to use (to callValueInstantiator.createFromLong(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, long)
).boolean
Method that can be called to check whether a property-based creator (argument-taking constructor or factory method) is available to instantiate values from JSON Objectboolean
Method that can be called to check whether a String-based creator is available for this instantiator.boolean
Method that can be called to check whether a array-delegate-based creator (single-arg constructor or factory method) is available for this instantiatorboolean
Method that can be called to check whether a default creator (constructor, or no-arg static factory method) is available for this instantiatorboolean
Method that can be called to check whether a delegate-based creator (single-arg constructor or factory method) is available for this instantiatorboolean
Method that will return true if any ofcanCreateXxx
method returns true: that is, if there is any way that an instance could be created.createContextual
(DeserializationContext ctxt, BeanDescription beanDesc) "Contextualization" method that is called after construction but before first use, to allow instantiator access to context needed to possible resolve its dependencies.createFromBigDecimal
(DeserializationContext ctxt, BigDecimal value) createFromBigInteger
(DeserializationContext ctxt, BigInteger value) createFromBoolean
(DeserializationContext ctxt, boolean value) createFromDouble
(DeserializationContext ctxt, double value) createFromInt
(DeserializationContext ctxt, int value) createFromLong
(DeserializationContext ctxt, long value) createFromObjectWith
(DeserializationContext ctxt, SettableBeanProperty[] props, PropertyValueBuffer buffer) Method that delegates toValueInstantiator.createFromObjectWith(DeserializationContext, Object[])
by default, but can be overridden if the application should have customized behavior with respect to missing properties.createFromObjectWith
(DeserializationContext ctxt, Object[] args) Method called to create value instance from JSON Object when instantiation arguments are passed; this is done, for example when passing information specified with "Creator" annotations.createFromString
(DeserializationContext ctxt, String value) createUsingArrayDelegate
(DeserializationContext ctxt, Object delegate) Method to called to create value instance from JSON Array using an intermediate "delegate" value to pass to createor methodMethod called to create value instance from a JSON value when no data needs to passed to creator (constructor, factory method); typically this will call the default constructor of the value object.createUsingDelegate
(DeserializationContext ctxt, Object delegate) Method to called to create value instance from JSON Object using an intermediate "delegate" value to pass to createor methodprotected ValueInstantiator
delegate()
Method that can be called to try to access member (constructor, static factory method) that is used as the "array delegate creator".Method that can be used to determine what is the type of array delegate type to use, if any; if no delegates are used, will return null.Method that can be called to try to access member (constructor, static factory method) that is used as the "default creator" (creator that is called without arguments; typically default [zero-argument] constructor of the type).Method that can be called to try to access member (constructor, static factory method) that is used as the "delegate creator".getDelegateType
(DeserializationConfig config) Method that can be used to determine what is the type of delegate type to use, if any; if no delegates are used, will return null.Method called to determine types of instantiation arguments to use when creating instances with creator arguments (whenValueInstantiator.canCreateFromObjectWith()
returns true).Class<?>
Accessor for raw (type-erased) type of instances to create.Method that returns description of the value type this instantiator handles.Method that can be called to try to access member (constructor, static factory method) that is used as the "non-default creator" (constructor or factory method that takes one or more arguments).Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.ValueInstantiator
_createFromStringFallbacks, canCreateFromBigDecimal, canCreateFromBigInteger
-
Field Details
-
_delegate
-
-
Constructor Details
-
Delegating
-
-
Method Details
-
createContextual
public ValueInstantiator createContextual(DeserializationContext ctxt, BeanDescription beanDesc) throws JsonMappingException Description copied from class:ValueInstantiator
"Contextualization" method that is called after construction but before first use, to allow instantiator access to context needed to possible resolve its dependencies.- Overrides:
createContextual
in classValueInstantiator
- Parameters:
ctxt
- Currently active deserialization context: needed to (for example) resolvingTypeDeserializer
s.- Returns:
- This instance, if no change, or newly constructed instance
- Throws:
JsonMappingException
- If there are issues with contextualization
-
delegate
-
getValueClass
Description copied from class:ValueInstantiator
Accessor for raw (type-erased) type of instances to create.NOTE: since this method has not existed since beginning of Jackson 2.0 series, default implementation will just return
Object.class
; implementations are expected to override it with real value.- Overrides:
getValueClass
in classValueInstantiator
-
getValueTypeDesc
Description copied from class:ValueInstantiator
Method that returns description of the value type this instantiator handles. Used for error messages, diagnostics.- Overrides:
getValueTypeDesc
in classValueInstantiator
-
canInstantiate
public boolean canInstantiate()Description copied from class:ValueInstantiator
Method that will return true if any ofcanCreateXxx
method returns true: that is, if there is any way that an instance could be created.- Overrides:
canInstantiate
in classValueInstantiator
-
canCreateFromString
public boolean canCreateFromString()Description copied from class:ValueInstantiator
Method that can be called to check whether a String-based creator is available for this instantiator.NOTE: does NOT include possible case of fallbacks, or coercion; only considers explicit creator.
- Overrides:
canCreateFromString
in classValueInstantiator
-
canCreateFromInt
public boolean canCreateFromInt()Description copied from class:ValueInstantiator
Method that can be called to check whether an integer (int, Integer) based creator is available to use (to callValueInstantiator.createFromInt(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, int)
).- Overrides:
canCreateFromInt
in classValueInstantiator
-
canCreateFromLong
public boolean canCreateFromLong()Description copied from class:ValueInstantiator
Method that can be called to check whether a long (long, Long) based creator is available to use (to callValueInstantiator.createFromLong(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, long)
).- Overrides:
canCreateFromLong
in classValueInstantiator
-
canCreateFromDouble
public boolean canCreateFromDouble()Description copied from class:ValueInstantiator
Method that can be called to check whether a double (double / Double) based creator is available to use (to callValueInstantiator.createFromDouble(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, double)
).- Overrides:
canCreateFromDouble
in classValueInstantiator
-
canCreateFromBoolean
public boolean canCreateFromBoolean()Description copied from class:ValueInstantiator
Method that can be called to check whether a double (boolean / Boolean) based creator is available to use (to callValueInstantiator.createFromDouble(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext, double)
).- Overrides:
canCreateFromBoolean
in classValueInstantiator
-
canCreateUsingDefault
public boolean canCreateUsingDefault()Description copied from class:ValueInstantiator
Method that can be called to check whether a default creator (constructor, or no-arg static factory method) is available for this instantiator- Overrides:
canCreateUsingDefault
in classValueInstantiator
-
canCreateUsingDelegate
public boolean canCreateUsingDelegate()Description copied from class:ValueInstantiator
Method that can be called to check whether a delegate-based creator (single-arg constructor or factory method) is available for this instantiator- Overrides:
canCreateUsingDelegate
in classValueInstantiator
-
canCreateUsingArrayDelegate
public boolean canCreateUsingArrayDelegate()Description copied from class:ValueInstantiator
Method that can be called to check whether a array-delegate-based creator (single-arg constructor or factory method) is available for this instantiator- Overrides:
canCreateUsingArrayDelegate
in classValueInstantiator
-
canCreateFromObjectWith
public boolean canCreateFromObjectWith()Description copied from class:ValueInstantiator
Method that can be called to check whether a property-based creator (argument-taking constructor or factory method) is available to instantiate values from JSON Object- Overrides:
canCreateFromObjectWith
in classValueInstantiator
-
getFromObjectArguments
Description copied from class:ValueInstantiator
Method called to determine types of instantiation arguments to use when creating instances with creator arguments (whenValueInstantiator.canCreateFromObjectWith()
returns true). These arguments are bound from JSON, using specified property types to locate deserializers.NOTE: all properties will be of type
CreatorProperty
.- Overrides:
getFromObjectArguments
in classValueInstantiator
-
getDelegateType
Description copied from class:ValueInstantiator
Method that can be used to determine what is the type of delegate type to use, if any; if no delegates are used, will return null. If non-null type is returned, deserializer will bind JSON into specified type (using standard deserializer for that type), and pass that to instantiator.- Overrides:
getDelegateType
in classValueInstantiator
-
getArrayDelegateType
Description copied from class:ValueInstantiator
Method that can be used to determine what is the type of array delegate type to use, if any; if no delegates are used, will return null. If non-null type is returned, deserializer will bind JSON into specified type (using standard deserializer for that type), and pass that to instantiator.- Overrides:
getArrayDelegateType
in classValueInstantiator
-
createUsingDefault
Description copied from class:ValueInstantiator
Method called to create value instance from a JSON value when no data needs to passed to creator (constructor, factory method); typically this will call the default constructor of the value object. It will only be used if more specific creator methods are not applicable; hence "default".This method is called if
ValueInstantiator.getFromObjectArguments(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationConfig)
returns null or empty List.- Overrides:
createUsingDefault
in classValueInstantiator
- Throws:
IOException
-
createFromObjectWith
Description copied from class:ValueInstantiator
Method called to create value instance from JSON Object when instantiation arguments are passed; this is done, for example when passing information specified with "Creator" annotations.This method is called if
ValueInstantiator.getFromObjectArguments(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationConfig)
returns a non-empty List of arguments.- Overrides:
createFromObjectWith
in classValueInstantiator
- Throws:
IOException
-
createFromObjectWith
public Object createFromObjectWith(DeserializationContext ctxt, SettableBeanProperty[] props, PropertyValueBuffer buffer) throws IOException Description copied from class:ValueInstantiator
Method that delegates toValueInstantiator.createFromObjectWith(DeserializationContext, Object[])
by default, but can be overridden if the application should have customized behavior with respect to missing properties.The default implementation of this method uses
PropertyValueBuffer.getParameters(SettableBeanProperty[])
to read and validate all properties in bulk, possibly substituting defaults for missing properties or throwing exceptions for missing properties. An overridden implementation of this method could, for example, usePropertyValueBuffer.hasParameter(SettableBeanProperty)
andPropertyValueBuffer.getParameter(SettableBeanProperty)
to safely read the present properties only, and to have some other behavior for the missing properties.- Overrides:
createFromObjectWith
in classValueInstantiator
- Throws:
IOException
-
createUsingDelegate
Description copied from class:ValueInstantiator
Method to called to create value instance from JSON Object using an intermediate "delegate" value to pass to createor method- Overrides:
createUsingDelegate
in classValueInstantiator
- Throws:
IOException
-
createUsingArrayDelegate
public Object createUsingArrayDelegate(DeserializationContext ctxt, Object delegate) throws IOException Description copied from class:ValueInstantiator
Method to called to create value instance from JSON Array using an intermediate "delegate" value to pass to createor method- Overrides:
createUsingArrayDelegate
in classValueInstantiator
- Throws:
IOException
-
createFromString
- Overrides:
createFromString
in classValueInstantiator
- Throws:
IOException
-
createFromInt
- Overrides:
createFromInt
in classValueInstantiator
- Throws:
IOException
-
createFromLong
- Overrides:
createFromLong
in classValueInstantiator
- Throws:
IOException
-
createFromBigInteger
public Object createFromBigInteger(DeserializationContext ctxt, BigInteger value) throws IOException - Overrides:
createFromBigInteger
in classValueInstantiator
- Throws:
IOException
-
createFromDouble
- Overrides:
createFromDouble
in classValueInstantiator
- Throws:
IOException
-
createFromBigDecimal
public Object createFromBigDecimal(DeserializationContext ctxt, BigDecimal value) throws IOException - Overrides:
createFromBigDecimal
in classValueInstantiator
- Throws:
IOException
-
createFromBoolean
- Overrides:
createFromBoolean
in classValueInstantiator
- Throws:
IOException
-
getDefaultCreator
Description copied from class:ValueInstantiator
Method that can be called to try to access member (constructor, static factory method) that is used as the "default creator" (creator that is called without arguments; typically default [zero-argument] constructor of the type). Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even ifValueInstantiator.canCreateUsingDefault()
returns true, this method may return null .- Overrides:
getDefaultCreator
in classValueInstantiator
-
getDelegateCreator
Description copied from class:ValueInstantiator
Method that can be called to try to access member (constructor, static factory method) that is used as the "delegate creator". Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even ifValueInstantiator.canCreateUsingDelegate()
returns true, this method may return null .- Overrides:
getDelegateCreator
in classValueInstantiator
-
getArrayDelegateCreator
Description copied from class:ValueInstantiator
Method that can be called to try to access member (constructor, static factory method) that is used as the "array delegate creator". Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even ifValueInstantiator.canCreateUsingArrayDelegate()
returns true, this method may return null .- Overrides:
getArrayDelegateCreator
in classValueInstantiator
-
getWithArgsCreator
Description copied from class:ValueInstantiator
Method that can be called to try to access member (constructor, static factory method) that is used as the "non-default creator" (constructor or factory method that takes one or more arguments). Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even ifValueInstantiator.canCreateFromObjectWith()
returns true, this method may return null .- Overrides:
getWithArgsCreator
in classValueInstantiator
-