Class BeanPropertyDefinition
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition
- All Implemented Interfaces:
Named
- Direct Known Subclasses:
POJOPropertyBuilder
,SimpleBeanPropertyDefinition
Simple value classes that contain definitions of properties,
used during introspection of properties to use for
serialization and deserialization purposes.
These instances are created before actual
BeanProperty
instances are created, i.e. they are used earlier in the process
flow, and are typically use to construct actual
BeanProperty
instances.-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
abstract JsonInclude.Value
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.Method used to find accessor (getter, field to access) to use for accessing value of the property.abstract AnnotatedParameter
Additional method that may be called instead ofgetConstructorParameter()
to get access to all constructor parameters, not just the highest priority one.abstract AnnotatedField
getField()
abstract PropertyName
abstract AnnotatedMethod
abstract String
Accessor that can be used to determine implicit name from underlying element(s) before possible renaming.abstract PropertyMetadata
Method for accessing additional metadata.Method used to find mutator (constructor parameter, setter, field) to use for changing value of the property.abstract String
getName()
Accessor for name used for external representation (in JSON).abstract AnnotatedMember
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.abstract JavaType
abstract Class<?>
abstract AnnotatedMethod
abstract PropertyName
Accessor for finding wrapper name to use for property (if any).abstract boolean
abstract boolean
hasField()
abstract boolean
boolean
hasName
(PropertyName name) abstract boolean
abstract 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
Method used to check if this property is expected to have a value; and if none found, should either be considered invalid (and most likely fail deserialization), or handled by other means (by providing default value)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.abstract BeanPropertyDefinition
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 whichgetName()
would returnnewName
.abstract BeanPropertyDefinition
withSimpleName
(String newSimpleName) Alternate "mutant factory" that will only change simple name, but leave other optional parts (like namespace) as is.
-
Field Details
-
EMPTY_INCLUDE
-
-
Constructor Details
-
BeanPropertyDefinition
public BeanPropertyDefinition()
-
-
Method Details
-
withName
Method that can be used to create a definition with same settings as this one, but with different (external) name; that is, one for whichgetName()
would returnnewName
.- Since:
- 2.3
-
withSimpleName
Alternate "mutant factory" that will only change simple name, but leave other optional parts (like namespace) as is.- Since:
- 2.3
-
getName
Accessor for name used for external representation (in JSON). -
getFullName
-
hasName
- Since:
- 2.6
-
getInternalName
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. -
getWrapperName
Accessor for finding wrapper name to use for property (if any).- Since:
- 2.2
-
isExplicitlyIncluded
public abstract boolean isExplicitlyIncluded()Accessor that can be called to check whether property was included due to an explicit marker (usually annotation), or just by naming convention.- 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()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
isExplicitlyIncluded()
, but not necessarily vice versa.- Since:
- 2.4
-
getPrimaryType
- Since:
- 2.9
-
getRawPrimaryType
- Since:
- 2.9
-
getMetadata
Method for accessing additional metadata. NOTE: will never return null, so de-referencing return value is safe.- Since:
- 2.3
-
isRequired
public boolean isRequired()Method used to check if this property is expected to have a value; and if none found, should either be considered invalid (and most likely fail deserialization), or handled by other means (by providing default value) -
couldDeserialize
public boolean couldDeserialize() -
couldSerialize
public boolean couldSerialize() -
hasGetter
public abstract boolean hasGetter() -
hasSetter
public abstract boolean hasSetter() -
hasField
public abstract boolean hasField() -
hasConstructorParameter
public abstract boolean hasConstructorParameter() -
getGetter
-
getSetter
-
getField
-
getConstructorParameter
-
getConstructorParameters
Additional method that may be called instead ofgetConstructorParameter()
to get access to all constructor parameters, not just the highest priority one.- Since:
- 2.5
-
getAccessor
Method used to find accessor (getter, field to access) to use for accessing value of the property. Null if no such member exists. -
getMutator
Method used to find mutator (constructor parameter, setter, field) to use for changing value of the property. Null if no such member exists. -
getNonConstructorMutator
- Since:
- 2.3
-
getPrimaryMember
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
- Since:
- 2.1
-
findViews
Method used to find View-inclusion definitions for the property. -
findReferenceType
Method used to find whether property is part of a bi-directional reference. -
findReferenceName
- Since:
- 2.9
-
isTypeId
public 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. -
findObjectIdInfo
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). -
findInclusion
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)- Since:
- 2.5
-