com.openpojo.business.utils.BusinessPojoHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openpojo Show documentation

This project was born out of a need to validate all POJOs (Plain Old Java Object) are behaving correctly. This project has two main aspects to it: * Make Testing as easy as possible. * Simplifying identity management (hashCode / equals) using annotation.

There is a newer version: 0.7.3

Show newest version

/**
 * Copyright (C) 2010 Osman Shoukry
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */
package com.openpojo.business.utils;

import java.util.LinkedList;
import java.util.List;

import com.openpojo.business.annotation.BusinessKey;
import com.openpojo.reflection.PojoClass;
import com.openpojo.reflection.PojoField;
import com.openpojo.reflection.impl.PojoClassFactory;

/**
 * This Utility helper class that holds the logic of extracting the {@link BusinessKey} fields from a Class.
 *
 * @author oshoukry
 */
public class BusinessPojoHelper {

    /**
     * Get all business keys declared on a class and the parent super classes.
     *
     * @param clazz
     *            The class to introspect.
     * @return
     *         The list of fields that are annotated with @BusinessKey, will return an empty list if none are found.
     */
    public static List getBusinessKeyFields(final Class clazz) {
        List businessFields = new LinkedList();
        PojoClass pojoClass = PojoClassFactory.getPojoClass(clazz);

        List rawFields = new LinkedList();
        rawFields.addAll(pojoClass.getPojoFields());


        PojoClass parent = pojoClass.getSuperClass();
        while (parent != null) {
            rawFields.addAll(parent.getPojoFields());
            parent = parent.getSuperClass();
        }

        for (PojoField pojoField : rawFields) {
            if (pojoField.getAnnotation(BusinessKey.class) != null) {
                businessFields.add(pojoField);
            }
        }
        return businessFields;
    }

}