Class POJOPropertyBuilder
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder
- All Implemented Interfaces:
Named
,Comparable<POJOPropertyBuilder>
public class POJOPropertyBuilder
extends BeanPropertyDefinition
implements Comparable<POJOPropertyBuilder>
Helper class used for aggregating information about a single
potential POJO property.
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static final class
Node used for creating simple linked lists to efficiently store small sets of things.protected static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected final AnnotationIntrospector
protected final MapperConfig<?>
protected POJOPropertyBuilder.Linked<AnnotatedParameter>
protected POJOPropertyBuilder.Linked<AnnotatedField>
protected final boolean
Whether property is being composed for serialization (true) or deserialization (false)protected POJOPropertyBuilder.Linked<AnnotatedMethod>
protected final PropertyName
Original internal name, derived from accessor, of this property.protected PropertyMetadata
protected final PropertyName
External name of logical property; may change with renaming (by new instance being constructed using a new name)protected AnnotationIntrospector.ReferenceProperty
Lazily accessed information about this property iff it is a forward or back reference.protected POJOPropertyBuilder.Linked<AnnotatedMethod>
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition
EMPTY_INCLUDE
-
Constructor Summary
ModifierConstructorDescriptionPOJOPropertyBuilder
(MapperConfig<?> config, AnnotationIntrospector ai, boolean forSerialization, PropertyName internalName) protected
POJOPropertyBuilder
(MapperConfig<?> config, AnnotationIntrospector ai, boolean forSerialization, PropertyName internalName, PropertyName name) protected
POJOPropertyBuilder
(POJOPropertyBuilder src, PropertyName newName) -
Method Summary
Modifier and TypeMethodDescriptionprotected PropertyMetadata
_getSetterInfo
(PropertyMetadata metadata, AnnotatedMember primary) Helper method that contains logic for accessing and merging all setter information that we needed, regarding things like possible merging of property value, and handling of incoming nulls.protected int
protected Class<?>
protected AnnotatedMethod
_selectSetter
(AnnotatedMethod currM, AnnotatedMethod nextM) protected AnnotatedMethod
_selectSetterFromMultiple
(POJOPropertyBuilder.Linked<AnnotatedMethod> curr, POJOPropertyBuilder.Linked<AnnotatedMethod> next) Helper method called in cases where we have encountered two setter methods that have same precedence and cannot be resolved.protected int
void
Method for adding all property members from specified collector into this collector.void
addCtor
(AnnotatedParameter a, PropertyName name, boolean explName, boolean visible, boolean ignored) void
addField
(AnnotatedField a, PropertyName name, boolean explName, boolean visible, boolean ignored) void
addGetter
(AnnotatedMethod a, PropertyName name, boolean explName, boolean visible, boolean ignored) void
addSetter
(AnnotatedMethod a, PropertyName name, boolean explName, boolean visible, boolean ignored) boolean
boolean
boolean
int
compareTo
(POJOPropertyBuilder other) boolean
boolean
explode
(Collection<PropertyName> newNames) Method called when a previous call tofindExplicitNames()
found multiple distinct explicit names, and the property this builder represents basically needs to be broken apart and replaced by a set of more than one properties.Method called to find out set of explicit names for accessors bound together due to implicit name.Method used to check if this property has specific inclusion override associated with it or not.Method used to check whether this logical property indicates that value POJOs should be written using additional Object Identifier (or, when multiple references exist, all but first AS Object Identifier).Method used to find whether property is part of a bi-directional reference.Class<?>[]
Method used to find View-inclusion definitions for the property.protected <T> T
fromMemberAnnotations
(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder.WithMember<T> func) Helper method used for finding annotation values, from accessors relevant to current usage (deserialization, serialization)protected <T> T
fromMemberAnnotationsExcept
(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder.WithMember<T> func, T defaultValue) Additional method that may be called instead ofBeanPropertyDefinition.getConstructorParameter()
to get access to all constructor parameters, not just the highest priority one.getField()
protected AnnotatedField
Variant ofgetField()
that does NOT trigger pruning of Field candidates.protected AnnotatedMethod
Variant ofgetGetter()
that does NOT trigger pruning of getter candidates.Accessor that can be used to determine implicit name from underlying element(s) before possible renaming.Method for accessing additional metadata.getName()
Accessor for name used for external representation (in JSON).Method used to find the property member (getter, setter, field) that has the highest precedence in current context (getter method when serializing, if available, and so forth), if any.protected AnnotatedMember
Type determined from the primary member for the property being built, considering precedence according to whether we are processing serialization or deserialization.Class<?>
protected AnnotatedMethod
Variant ofgetSetter()
that does NOT trigger pruning of setter candidates.Accessor for finding wrapper name to use for property (if any).boolean
boolean
hasField()
boolean
boolean
hasName
(PropertyName name) boolean
boolean
Accessor that can be called to check whether property was included due to an explicit marker (usually annotation), or just by naming convention.boolean
Accessor that can be called to check whether property name was due to an explicit marker (usually annotation), or just by naming convention or use of "use-default-name" marker (annotation).boolean
isTypeId()
Method used to check whether this logical property has a marker to indicate it should be used as the type id for polymorphic type handling.void
mergeAnnotations
(boolean forSerialization) void
Mutator that will simply drop any constructor parameters property may have.void
Method called to remove all entries that are marked as ignored.removeNonVisible
(boolean inferMutators) Deprecated.removeNonVisible
(boolean inferMutators, POJOPropertiesCollector parent) toString()
void
Method called to trim unnecessary entries, such as implicit getter if there is an explict one available.withName
(PropertyName newName) Method that can be used to create a definition with same settings as this one, but with different (external) name; that is, one for whichBeanPropertyDefinition.getName()
would returnnewName
.withSimpleName
(String newSimpleName) Alternate "mutant factory" that will only change simple name, but leave other optional parts (like namespace) as is.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition
findReferenceName, getAccessor, getMutator, getNonConstructorMutator, isRequired
-
Field Details
-
_forSerialization
protected final boolean _forSerializationWhether property is being composed for serialization (true) or deserialization (false) -
_config
-
_annotationIntrospector
-
_name
External name of logical property; may change with renaming (by new instance being constructed using a new name) -
_internalName
Original internal name, derived from accessor, of this property. Will not be changed by renaming. -
_fields
-
_ctorParameters
-
_getters
-
_setters
-
_metadata
-
_referenceInfo
Lazily accessed information about this property iff it is a forward or back reference.- Since:
- 2.9
-
-
Constructor Details
-
POJOPropertyBuilder
public POJOPropertyBuilder(MapperConfig<?> config, AnnotationIntrospector ai, boolean forSerialization, PropertyName internalName) -
POJOPropertyBuilder
protected POJOPropertyBuilder(MapperConfig<?> config, AnnotationIntrospector ai, boolean forSerialization, PropertyName internalName, PropertyName name) -
POJOPropertyBuilder
-
-
Method Details
-
withName
Description copied from class:BeanPropertyDefinition
Method that can be used to create a definition with same settings as this one, but with different (external) name; that is, one for whichBeanPropertyDefinition.getName()
would returnnewName
.- Specified by:
withName
in classBeanPropertyDefinition
-
withSimpleName
Description copied from class:BeanPropertyDefinition
Alternate "mutant factory" that will only change simple name, but leave other optional parts (like namespace) as is.- Specified by:
withSimpleName
in classBeanPropertyDefinition
-
compareTo
- Specified by:
compareTo
in interfaceComparable<POJOPropertyBuilder>
-
getName
Description copied from class:BeanPropertyDefinition
Accessor for name used for external representation (in JSON).- Specified by:
getName
in interfaceNamed
- Specified by:
getName
in classBeanPropertyDefinition
-
getFullName
- Specified by:
getFullName
in classBeanPropertyDefinition
-
hasName
- Overrides:
hasName
in classBeanPropertyDefinition
-
getInternalName
Description copied from class:BeanPropertyDefinition
Accessor that can be used to determine implicit name from underlying element(s) before possible renaming. This is the "internal" name derived from accessor ("x" from "getX"), and is not based on annotations or naming strategy.- Specified by:
getInternalName
in classBeanPropertyDefinition
-
getWrapperName
Description copied from class:BeanPropertyDefinition
Accessor for finding wrapper name to use for property (if any).- Specified by:
getWrapperName
in classBeanPropertyDefinition
-
isExplicitlyIncluded
public boolean isExplicitlyIncluded()Description copied from class:BeanPropertyDefinition
Accessor that can be called to check whether property was included due to an explicit marker (usually annotation), or just by naming convention.- Specified by:
isExplicitlyIncluded
in classBeanPropertyDefinition
- Returns:
- True if property was explicitly included (usually by having one of components being annotated); false if inclusion was purely due to naming or visibility definitions (that is, implicit)
-
isExplicitlyNamed
public boolean isExplicitlyNamed()Description copied from class:BeanPropertyDefinition
Accessor that can be called to check whether property name was due to an explicit marker (usually annotation), or just by naming convention or use of "use-default-name" marker (annotation).Note that entries that return true from this method will always return true for
BeanPropertyDefinition.isExplicitlyIncluded()
, but not necessarily vice versa.- Overrides:
isExplicitlyNamed
in classBeanPropertyDefinition
-
getMetadata
Description copied from class:BeanPropertyDefinition
Method for accessing additional metadata. NOTE: will never return null, so de-referencing return value is safe.- Specified by:
getMetadata
in classBeanPropertyDefinition
-
_getSetterInfo
Helper method that contains logic for accessing and merging all setter information that we needed, regarding things like possible merging of property value, and handling of incoming nulls. Only called for deserialization purposes. -
getPrimaryType
Type determined from the primary member for the property being built, considering precedence according to whether we are processing serialization or deserialization.- Specified by:
getPrimaryType
in classBeanPropertyDefinition
-
getRawPrimaryType
- Specified by:
getRawPrimaryType
in classBeanPropertyDefinition
-
hasGetter
public boolean hasGetter()- Specified by:
hasGetter
in classBeanPropertyDefinition
-
hasSetter
public boolean hasSetter()- Specified by:
hasSetter
in classBeanPropertyDefinition
-
hasField
public boolean hasField()- Specified by:
hasField
in classBeanPropertyDefinition
-
hasConstructorParameter
public boolean hasConstructorParameter()- Specified by:
hasConstructorParameter
in classBeanPropertyDefinition
-
couldDeserialize
public boolean couldDeserialize()- Overrides:
couldDeserialize
in classBeanPropertyDefinition
-
couldSerialize
public boolean couldSerialize()- Overrides:
couldSerialize
in classBeanPropertyDefinition
-
getGetter
- Specified by:
getGetter
in classBeanPropertyDefinition
-
getGetterUnchecked
Variant ofgetGetter()
that does NOT trigger pruning of getter candidates. -
getSetter
- Specified by:
getSetter
in classBeanPropertyDefinition
-
getSetterUnchecked
Variant ofgetSetter()
that does NOT trigger pruning of setter candidates. -
_selectSetterFromMultiple
protected AnnotatedMethod _selectSetterFromMultiple(POJOPropertyBuilder.Linked<AnnotatedMethod> curr, POJOPropertyBuilder.Linked<AnnotatedMethod> next) Helper method called in cases where we have encountered two setter methods that have same precedence and cannot be resolved. This does not yet necessarily mean a failure since it is possible something with a higher precedence could still be found; handling is just separated into separate method for convenience.- Parameters:
curr
-next
-- Returns:
- Chosen setter method, if any
- Throws:
IllegalArgumentException
- If conflict could not be resolved- Since:
- 2.13
-
_selectSetter
-
getField
- Specified by:
getField
in classBeanPropertyDefinition
-
getFieldUnchecked
Variant ofgetField()
that does NOT trigger pruning of Field candidates. -
getConstructorParameter
- Specified by:
getConstructorParameter
in classBeanPropertyDefinition
-
getConstructorParameters
Description copied from class:BeanPropertyDefinition
Additional method that may be called instead ofBeanPropertyDefinition.getConstructorParameter()
to get access to all constructor parameters, not just the highest priority one.- Overrides:
getConstructorParameters
in classBeanPropertyDefinition
-
getPrimaryMember
Description copied from class:BeanPropertyDefinition
Method used to find the property member (getter, setter, field) that has the highest precedence in current context (getter method when serializing, if available, and so forth), if any.Note: may throw
IllegalArgumentException
in case problems are found trying to getter or setter info.Note: abstract since 2.5
- Specified by:
getPrimaryMember
in classBeanPropertyDefinition
-
getPrimaryMemberUnchecked
-
_getterPriority
-
_setterPriority
-
findViews
Description copied from class:BeanPropertyDefinition
Method used to find View-inclusion definitions for the property.- Overrides:
findViews
in classBeanPropertyDefinition
-
findReferenceType
Description copied from class:BeanPropertyDefinition
Method used to find whether property is part of a bi-directional reference.- Overrides:
findReferenceType
in classBeanPropertyDefinition
-
isTypeId
public boolean isTypeId()Description copied from class:BeanPropertyDefinition
Method used to check whether this logical property has a marker to indicate it should be used as the type id for polymorphic type handling.- Overrides:
isTypeId
in classBeanPropertyDefinition
-
findObjectIdInfo
Description copied from class:BeanPropertyDefinition
Method used to check whether this logical property indicates that value POJOs should be written using additional Object Identifier (or, when multiple references exist, all but first AS Object Identifier).- Overrides:
findObjectIdInfo
in classBeanPropertyDefinition
-
findInclusion
Description copied from class:BeanPropertyDefinition
Method used to check if this property has specific inclusion override associated with it or not. It should NOT check for any default settings (global, per-type, or containing POJO settings)- Specified by:
findInclusion
in classBeanPropertyDefinition
-
findAccess
-
addField
public void addField(AnnotatedField a, PropertyName name, boolean explName, boolean visible, boolean ignored) -
addCtor
public void addCtor(AnnotatedParameter a, PropertyName name, boolean explName, boolean visible, boolean ignored) -
addGetter
public void addGetter(AnnotatedMethod a, PropertyName name, boolean explName, boolean visible, boolean ignored) -
addSetter
public void addSetter(AnnotatedMethod a, PropertyName name, boolean explName, boolean visible, boolean ignored) -
addAll
Method for adding all property members from specified collector into this collector. -
removeIgnored
public void removeIgnored()Method called to remove all entries that are marked as ignored. -
removeNonVisible
Deprecated. -
removeNonVisible
- Parameters:
inferMutators
- Whether mutators can be "pulled in" by visible accessors or not.- Since:
- 2.12 (earlier had different signature)
-
removeConstructors
public void removeConstructors()Mutator that will simply drop any constructor parameters property may have.- Since:
- 2.5
-
trimByVisibility
public void trimByVisibility()Method called to trim unnecessary entries, such as implicit getter if there is an explict one available. This is important for later stages, to avoid unnecessary conflicts. -
mergeAnnotations
public void mergeAnnotations(boolean forSerialization) -
anyVisible
public boolean anyVisible() -
anyIgnorals
public boolean anyIgnorals() -
anyExplicitsWithoutIgnoral
public boolean anyExplicitsWithoutIgnoral() -
findExplicitNames
Method called to find out set of explicit names for accessors bound together due to implicit name.- Since:
- 2.4
-
explode
Method called when a previous call tofindExplicitNames()
found multiple distinct explicit names, and the property this builder represents basically needs to be broken apart and replaced by a set of more than one properties.- Since:
- 2.4
-
toString
-
fromMemberAnnotations
protected <T> T fromMemberAnnotations(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder.WithMember<T> func) Helper method used for finding annotation values, from accessors relevant to current usage (deserialization, serialization) -
fromMemberAnnotationsExcept
protected <T> T fromMemberAnnotationsExcept(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder.WithMember<T> func, T defaultValue) -
_rawTypeOf
-