com.fasterxml.jackson.databind.util.SimpleBeanPropertyDefinition Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagger-all Show documentation
Show all versions of swagger-all Show documentation
swagger-all is a rebundled verison of Swagger as one OSGi bundle.
package com.fasterxml.jackson.databind.util;
import com.fasterxml.jackson.databind.AnnotationIntrospector;
import com.fasterxml.jackson.databind.PropertyMetadata;
import com.fasterxml.jackson.databind.PropertyName;
import com.fasterxml.jackson.databind.cfg.MapperConfig;
import com.fasterxml.jackson.databind.introspect.*;
/**
* Simple immutable {@link BeanPropertyDefinition} implementation that can
* be wrapped around a {@link AnnotatedMember} that is a simple
* accessor (getter) or mutator (setter, constructor parameter)
* (or both, for fields).
*/
public class SimpleBeanPropertyDefinition
extends BeanPropertyDefinition
{
protected final AnnotationIntrospector _introspector;
/**
* 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.
*/
protected final AnnotatedMember _member;
protected final String _name;
/*
/**********************************************************
/* Construction
/**********************************************************
*/
/**
* @since 2.2 Use {@link #construct} instead
*/
@Deprecated
public SimpleBeanPropertyDefinition(AnnotatedMember member) {
this(member, member.getName(), null);
}
/**
* @since 2.2 Use {@link #construct} instead
*/
@Deprecated
public SimpleBeanPropertyDefinition(AnnotatedMember member, String name) {
this(member, name, null);
}
private SimpleBeanPropertyDefinition(AnnotatedMember member, String name,
AnnotationIntrospector intr) {
_introspector = intr;
_member = member;
_name = name;
}
/**
* @since 2.2
*/
public static SimpleBeanPropertyDefinition construct(MapperConfig config,
AnnotatedMember member) {
return new SimpleBeanPropertyDefinition(member, member.getName(),
(config == null) ? null : config.getAnnotationIntrospector());
}
/**
* @since 2.2
*/
public static SimpleBeanPropertyDefinition construct(MapperConfig config,
AnnotatedMember member, String name) {
return new SimpleBeanPropertyDefinition(member, name,
(config == null) ? null : config.getAnnotationIntrospector());
}
/*
/**********************************************************
/* Fluent factories
/**********************************************************
*/
@Deprecated // since 2.3
@Override
public SimpleBeanPropertyDefinition withName(String newName) {
return withSimpleName(newName);
}
@Override
public SimpleBeanPropertyDefinition withSimpleName(String newName) {
if (_name.equals(newName)) {
return this;
}
return new SimpleBeanPropertyDefinition(_member, newName, _introspector);
}
@Override
public SimpleBeanPropertyDefinition withName(PropertyName newName) {
return withSimpleName(newName.getSimpleName());
}
/*
/**********************************************************
/* Basic property information, name, type
/**********************************************************
*/
@Override
public String getName() { return _name; }
@Override
public PropertyName getFullName() { return new PropertyName(_name); }
@Override
public String getInternalName() { return getName(); }
@Override
public PropertyName getWrapperName() {
return (_introspector == null) ? null : _introspector.findWrapperName(_member);
}
// hmmh. what should we claim here?
@Override public boolean isExplicitlyIncluded() { return false; }
@Override public boolean isExplicitlyNamed() { return false; }
/**
* We will indicate that property is optional, since there is nothing
* to indicate whether it might be required.
*/
@Override
public PropertyMetadata getMetadata() {
return PropertyMetadata.STD_OPTIONAL;
}
/*
/**********************************************************
/* Access to accessors (fields, methods etc)
/**********************************************************
*/
@Override
public boolean hasGetter() { return (getGetter() != null); }
@Override
public boolean hasSetter() { return (getSetter() != null); }
@Override
public boolean hasField() { return (_member instanceof AnnotatedField); }
@Override
public boolean hasConstructorParameter() { return (_member instanceof AnnotatedParameter); }
@Override
public AnnotatedMethod getGetter() {
if ((_member instanceof AnnotatedMethod)
&& ((AnnotatedMethod) _member).getParameterCount() == 0) {
return (AnnotatedMethod) _member;
}
return null;
}
@Override
public AnnotatedMethod getSetter() {
if ((_member instanceof AnnotatedMethod)
&& ((AnnotatedMethod) _member).getParameterCount() == 1) {
return (AnnotatedMethod) _member;
}
return null;
}
@Override
public AnnotatedField getField() {
return (_member instanceof AnnotatedField) ? (AnnotatedField) _member : null;
}
@Override
public AnnotatedParameter getConstructorParameter() {
return (_member instanceof AnnotatedParameter) ? (AnnotatedParameter) _member : null;
}
/**
* Method used to find accessor (getter, field to access) to use for accessing
* value of the property.
* Null if no such member exists.
*/
@Override
public AnnotatedMember getAccessor() {
AnnotatedMember acc = getGetter();
if (acc == null) {
acc = getField();
}
return acc;
}
/**
* Method used to find mutator (constructor parameter, setter, field) to use for
* changing value of the property.
* Null if no such member exists.
*/
@Override
public AnnotatedMember getMutator() {
AnnotatedMember acc = getConstructorParameter();
if (acc == null) {
acc = getSetter();
if (acc == null) {
acc = getField();
}
}
return acc;
}
@Override
public AnnotatedMember getNonConstructorMutator() {
AnnotatedMember acc = getSetter();
if (acc == null) {
acc = getField();
}
return acc;
}
@Override
public AnnotatedMember getPrimaryMember() { return _member; }
}