yakworks.meta.MetaUtils.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.meta

import java.lang.reflect.Modifier

import groovy.transform.CompileStatic

/**
 * A bunch of helper and lookup/finder statics for dealing with domain classes and PersistentEntity.
 * Useful methods to find the PersistentEntity and the mapping and meta fields.
 *
 * @author Joshua Burnett (@basejump)
 * @since 6.1
 */
@CompileStatic
class MetaUtils {

    // list of props to exclude in isExcluded used for getProperties
    private static List PROPERTY_EXCLUDES = [
        "class", "declaringClass", "metaClass"
    ]

    /**
     * only returns the instance metaProperties
     * Get the meta properties for and object but filters out statics and props without a getter
     */
    static List getMetaProperties(Class entityClass) {
        List metaProps = entityClass.metaClass.properties
        List filteredProps = metaProps.findAll { MetaProperty mp ->
            !isExcludedProperty(mp)
        }
        return filteredProps
    }

    /**
     * the default Groovy getProperties returns statics.
     * This only returns the instance values
     */
    static Map getProperties(Object instance) {
        Map props = [:]
        for (MetaProperty mp : getMetaProperties(instance.class)) {
            props[mp.name] = mp.getProperty(instance)
        }
        return props
    }

    /**
     * used for getProperties to exclude the utility properties that are on a GormEntity.
     */
    static boolean isExcludedProperty(MetaProperty mp) {
        return Modifier.isStatic(mp.getModifiers()) ||
            PROPERTY_EXCLUDES.contains(mp.getName()) ||
            (mp instanceof MetaBeanProperty) && (((MetaBeanProperty) mp).getGetter()) == null
    }

}