com.fasterxml.jackson.jr.ob.impl.POJODefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jackson-jr-objects Show documentation
Simple data-binding that builds directly on jackson-core (streaming), has no other dependencies, and provides additional builder-style content generator
The newest version!
package com.fasterxml.jackson.jr.ob.impl;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.*;

/**
 * Definition of a single Bean-style Java class, without assumptions
 * on usage for serialization or deserialization, used as input
 * for constructing bean readers and writers.
 *
 * @since 2.8
 */
public class POJODefinition
{
    protected final Class _type;

    protected final Prop[] _properties;

    /**
     * Possible per-class definition of names that may be ignored safely
     * during deserialization.
     *
     * @since 2.11
     */
    protected final Set _ignorableNames;

    /**
     * @since 2.17
     */
    protected final BeanConstructors _constructors;

    /**
     * @since 2.17
     */
    public POJODefinition(Class type, Prop[] props,
            BeanConstructors constructors)
    {
        _type = type;
        _properties = props;
        _constructors = constructors;
        _ignorableNames = null;
    }

    @Deprecated // Since 2.17
    public POJODefinition(Class type, Prop[] props,
            Constructor defaultCtor, Constructor stringCtor, Constructor longCtor)
    {
        this(type, props,
                new BeanConstructors(type)
                .addNoArgsConstructor(defaultCtor)
                .addStringConstructor(stringCtor)
                .addLongConstructor(longCtor));
    }

    protected POJODefinition(POJODefinition base,
            Prop[] props, Set ignorableN)
    {
        _type = base._type;
        _properties = props;
        _constructors = base._constructors;
        _ignorableNames = ignorableN;
    }

    public POJODefinition withProperties(Collection props) {
        return new POJODefinition(this, props.toArray(new Prop[0]), _ignorableNames);
    }

    // @since 2.11
    public POJODefinition withIgnorals(Set ignorableN) {
        return new POJODefinition(this, _properties, ignorableN);
    }

    /*
    /**********************************************************************
    /* Public API
    /**********************************************************************
     */

    public List getProperties() {
        return Arrays.asList(_properties);
    }

    public Set getIgnorableNames() {
        if (_ignorableNames == null) {
            return Collections.emptySet();
        }
        return _ignorableNames;
    }

    /**
     * @since 2.17
     */
    public BeanConstructors constructors() {
        return _constructors;
    }

    /*
    /**********************************************************************
    /* Helper class for containing property definitions
    /**********************************************************************
     */

    public static final class Prop
    {
        public final String name;

        public final Field field;
        public final Method setter, getter, isGetter;

        private final Collection aliases;

        public Prop(String n, Field f,
                Method setter0, Method getter0, Method isGetter0,
                Collection aliases0)
        {
            name = n;
            field = f;
            setter = setter0;
            getter = getter0;
            isGetter = isGetter0;
            if (aliases0 == null) {
                aliases0 = Collections.emptyList();
            }
            aliases = aliases0;
        }

        public static PropBuilder builder(String name) {
            return new PropBuilder(name);
        }

        public boolean hasSetter() {
            return (setter != null) || (field != null);
        }

        public boolean hasAliases() {
            return !aliases.isEmpty();
        }

        public Iterable aliases() {
            return aliases;
        }
    }

    static final class PropBuilder {
        private final String _name;

        private Field _field;
        private Method _setter, _getter, _isGetter;

        public PropBuilder(String name) {
            _name = name;
        }

        public Prop build() {
            return new Prop(_name, _field, _setter, _getter, _isGetter, null);
        }

        public PropBuilder withField(Field f) {
            _field = f;
            return this;
        }

        public PropBuilder withSetter(Method m) {
            _setter = m;
            return this;
        }

        public PropBuilder withGetter(Method m) {
            _getter = m;
            return this;
        }

        public PropBuilder withIsGetter(Method m) {
            _isGetter = m;
            return this;
        }
    }
}