yakworks.commons.beans.BeanTools.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of groovy-commons Show documentation

common groovy and java utils

The newest version!

/*
* Copyright 2019 original authors
* SPDX-License-Identifier: Apache-2.0
*/
package yakworks.commons.beans

import groovy.transform.CompileStatic

import org.codehaus.groovy.runtime.InvokerHelper

import yakworks.commons.map.Maps
import yakworks.json.jackson.JacksonJson

/**
 * helpers for Plain Old Groovy Objects and Beans
 *
 * @author Joshua Burnett (@basejump)
 */
@CompileStatic
class BeanTools {

    /**
     * shorter and more semanticly correct alias to getProperty
     */
    static Object value(Object source, String property) {
        PropertyTools.getProperty(source, property)
    }


    /**
     * Uses built in Groovy for Simple merging from a map to object, nested or not, onto the pogo.
     * Uses the InvokerHelper.setProperties(values)
     * Works well for most simple cases but does handle binding of a list of generics.
     * Use Jackson for those cases, see the bind mehtod here which does it.
     *
     * @see JacksonJson#bind
     */
    static Object merge( Object pogo, Map values, Map args = [:]){
        boolean ignoreNulls = args.containsKey('ignoreNulls') ? args['ignoreNulls'] : true
        if(ignoreNulls){
            values = Maps.prune(values)
        }
        return setProps(pogo, values)
    }

    /**
     * sets the properties in target from the source
     */
    public static  T setProps(T target, Object source){
        Map propsToMerge = source instanceof Map ? source : source.properties
        InvokerHelper.setProperties(target, propsToMerge)
        return target
    }

    /**
     * alias to setProps
     */
    public static  T copy(T target, Object source){
        return setProps(target, source)
    }

    /** Uses JacksonUtil and binds the data to new instance of the pased in clazz */
    public static  T bind(Object data, Class clazz)  {
        return JacksonJson.bind(data, clazz)
    }

    /** Uses JacksonUtil to bind to existing object instance */
    public static  T bind(T instance, Object data) {
        return JacksonJson.bind(instance, data)
    }

}