Module tools.jackson.databind

Package tools.jackson.databind.util

Class SimpleBeanPropertyDefinition

java.lang.Object

tools.jackson.databind.introspect.BeanPropertyDefinition

tools.jackson.databind.util.SimpleBeanPropertyDefinition

All Implemented Interfaces:

Named, FullyNamed

public class SimpleBeanPropertyDefinition
extends BeanPropertyDefinition

Simple immutable BeanPropertyDefinition implementation that can be wrapped around a AnnotatedMember that is a simple accessor (getter) or mutator (setter, constructor parameter) (or both, for fields).

Nested Class Summary

Nested classes/interfaces inherited from interface tools.jackson.core.util.Named

Named.StringAsNamed

Field Summary

Fields

Modifier and Type	Field	Description
protected final MapperConfig<?>	_config
protected final PropertyName	_fullName
protected final JsonInclude.Value	_inclusion
protected final AnnotatedMember	_member	Member that defines logical property.
protected final PropertyMetadata	_metadata

Fields inherited from class tools.jackson.databind.introspect.BeanPropertyDefinition

EMPTY_INCLUDE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleBeanPropertyDefinition(MapperConfig<?> config, AnnotatedMember member, PropertyName fullName, PropertyMetadata metadata, JsonInclude.Value inclusion)

Method Summary

Modifier and Type	Method	Description
static SimpleBeanPropertyDefinition	construct(MapperConfig<?> config, AnnotatedMember member)
static SimpleBeanPropertyDefinition	construct(MapperConfig<?> config, AnnotatedMember member, PropertyName name)
static SimpleBeanPropertyDefinition	construct(MapperConfig<?> config, AnnotatedMember member, PropertyName name, PropertyMetadata metadata, JsonInclude.Include inclusion)	Method called to create instance for virtual properties.
static SimpleBeanPropertyDefinition	construct(MapperConfig<?> config, AnnotatedMember member, PropertyName name, PropertyMetadata metadata, JsonInclude.Value inclusion)
List<PropertyName>	findAliases()	Method for finding all aliases of the property, if any.
JsonInclude.Value	findInclusion()	Method used to check if this property has specific inclusion override associated with it or not.
AnnotatedParameter	getConstructorParameter()
Iterator<AnnotatedParameter>	getConstructorParameters()	Additional method that may be called instead of BeanPropertyDefinition.getConstructorParameter() to get access to all constructor parameters, not just the highest priority one.
AnnotatedField	getField()
PropertyName	getFullName()
AnnotatedMethod	getGetter()
String	getInternalName()	Accessor that can be used to determine implicit name from underlying element(s) before possible renaming.
PropertyMetadata	getMetadata()	We will indicate that property is optional, since there is nothing to indicate whether it might be required.
String	getName()
AnnotatedMember	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.
JavaType	getPrimaryType()
Class<?>	getRawPrimaryType()
AnnotatedMethod	getSetter()
PropertyName	getWrapperName()	Accessor for finding wrapper name to use for property (if any).
boolean	hasConstructorParameter()
boolean	hasField()
boolean	hasGetter()
boolean	hasName(PropertyName name)
boolean	hasSetter()
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.
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).
BeanPropertyDefinition	withInclusion(JsonInclude.Value inclusion)
BeanPropertyDefinition	withMetadata(PropertyMetadata metadata)
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 which Named.getName() would return newName.
BeanPropertyDefinition	withSimpleName(String newName)	Alternate "mutant factory" that will only change simple name, but leave other optional parts (like namespace) as is.

Methods inherited from class tools.jackson.databind.introspect.BeanPropertyDefinition

couldDeserialize, couldSerialize, findObjectIdInfo, findReferenceName, findReferenceType, findViews, getAccessor, getMutator, getNonConstructorMutator, isRequired, isTypeId

Methods inherited from class java.lang.Object

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

Field Details

_config

protected final MapperConfig<?> _config

_member

protected final AnnotatedMember _member

Member that defines logical property. Assumption is that it should be a 'simple' accessor; meaning a zero-argument getter, single-argument setter or constructor parameter.

NOTE: for "virtual" properties, this is null.

_metadata

protected final PropertyMetadata _metadata

_fullName

protected final PropertyName _fullName

_inclusion

protected final JsonInclude.Value _inclusion

Constructor Details

SimpleBeanPropertyDefinition

protected SimpleBeanPropertyDefinition(MapperConfig<?> config,
 AnnotatedMember member,
 PropertyName fullName,
 PropertyMetadata metadata,
 JsonInclude.Value inclusion)

Method Details

construct

public static SimpleBeanPropertyDefinition construct(MapperConfig<?> config,
 AnnotatedMember member)

construct

public static SimpleBeanPropertyDefinition construct(MapperConfig<?> config,
 AnnotatedMember member,
 PropertyName name)

construct

public static SimpleBeanPropertyDefinition construct(MapperConfig<?> config,
 AnnotatedMember member,
 PropertyName name,
 PropertyMetadata metadata,
 JsonInclude.Include inclusion)

Method called to create instance for virtual properties.

construct

public static SimpleBeanPropertyDefinition construct(MapperConfig<?> config,
 AnnotatedMember member,
 PropertyName name,
 PropertyMetadata metadata,
 JsonInclude.Value inclusion)

Since:

2.7

withSimpleName

public BeanPropertyDefinition withSimpleName(String newName)

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 class BeanPropertyDefinition

withName

public BeanPropertyDefinition withName(PropertyName newName)

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 which Named.getName() would return newName.

Specified by:

withName in class BeanPropertyDefinition

withMetadata

public BeanPropertyDefinition withMetadata(PropertyMetadata metadata)

Since:

2.5

withInclusion

public BeanPropertyDefinition withInclusion(JsonInclude.Value inclusion)

Since:

2.5

getName

public String getName()

getFullName

public PropertyName getFullName()

hasName

public boolean hasName(PropertyName name)

getInternalName

public String 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 class BeanPropertyDefinition

getWrapperName

public PropertyName getWrapperName()

Description copied from class: BeanPropertyDefinition

Accessor for finding wrapper name to use for property (if any).

Specified by:

getWrapperName in class BeanPropertyDefinition

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 class BeanPropertyDefinition

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 class BeanPropertyDefinition

getMetadata

public PropertyMetadata getMetadata()

We will indicate that property is optional, since there is nothing to indicate whether it might be required.

Specified by:

getMetadata in class BeanPropertyDefinition

getPrimaryType

public JavaType getPrimaryType()

Specified by:

getPrimaryType in class BeanPropertyDefinition

getRawPrimaryType

public Class<?> getRawPrimaryType()

Specified by:

getRawPrimaryType in class BeanPropertyDefinition

findInclusion

public JsonInclude.Value 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 class BeanPropertyDefinition

findAliases

public List<PropertyName> findAliases()

Description copied from class: BeanPropertyDefinition

Method for finding all aliases of the property, if any.

Specified by:

findAliases in class BeanPropertyDefinition

Returns:

List of aliases, if any; never null (empty list if no aliases found)

hasGetter

public boolean hasGetter()

Specified by:

hasGetter in class BeanPropertyDefinition

hasSetter

public boolean hasSetter()

Specified by:

hasSetter in class BeanPropertyDefinition

hasField

public boolean hasField()

Specified by:

hasField in class BeanPropertyDefinition

hasConstructorParameter

public boolean hasConstructorParameter()

Specified by:

hasConstructorParameter in class BeanPropertyDefinition

getGetter

public AnnotatedMethod getGetter()

Specified by:

getGetter in class BeanPropertyDefinition

getSetter

public AnnotatedMethod getSetter()

Specified by:

getSetter in class BeanPropertyDefinition

getField

public AnnotatedField getField()

Specified by:

getField in class BeanPropertyDefinition

getConstructorParameter

public AnnotatedParameter getConstructorParameter()

Specified by:

getConstructorParameter in class BeanPropertyDefinition

getConstructorParameters

public Iterator<AnnotatedParameter> getConstructorParameters()

Description copied from class: BeanPropertyDefinition

Additional method that may be called instead of BeanPropertyDefinition.getConstructorParameter() to get access to all constructor parameters, not just the highest priority one.

Overrides:

getConstructorParameters in class BeanPropertyDefinition

getPrimaryMember

public AnnotatedMember 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 class BeanPropertyDefinition